C#在源文档生成非程序员

<p>软件组我目前在最近决定开始记录我们的代码库工作。他们已经采取的初步方法是使用内置的三斜杠///文档化的方法。 P&gt; </p><p>我们开始寻找一个新的问题是,通过doxygen的运行此的结果是代码库的一个很不错的表现,但对于一个程序员使用,我们本来打算为这个文档是由我们的系统工程师可读谁都会经常到我们这里来问什么任务是做准确。 p&gt; </p><p>有没有一种简单的方法使用的方式///方法和doxygen的,如果我们运行它以一定的方式,我们可以生成只包含文档的系统工程版本没有这些额外的文件来记录我们的代码一个标准的程序员文档会吓跑系统的家伙,例如方法和成员变量等的绒毛?任何替代方案的建议也欢迎。 P&gt; </p><p>我很抱歉,如果这是什么,我们正在努力去实现,我可以调整为响应进来有点混乱。 谢谢你。 P&gt;
</p>

38 浏览 1 回复
  文档   使用   工程   一个   gt  

回复

    <p>一件事你可以做的是使用的doxygen的 命令,它给你“相关页面”。创建由doxygen的处理的扩展名的文本文件,而只是把注释在那里。 (我用的.doc,但你可能要改变,要别的东西,以避免与Word文档。我也把这些文件称为公共目录混乱 让他们在一个地方。)然后,这些页面在文档一个单独的部分显示出来。 P&gt;</p><p>您可以创建链接到网页或章节 要么 P&gt; </p><p>在我们的项目中,基本上每个人谁与它使用的方案还围绕代码,因此它是好的,有代码的使用文档交联。但是,随着其他人指出,这可能不是一个典型的最终用户的文档的最佳解决方案。 P&gt; </p><p>我不认为这是会得到你想要的东西。这听起来像你真正想要的是有一个验证码,根据这些规范运行良好的规范文档的系统工程师可以使用,以及良好的单元测试。内嵌代码文档真的是多为软件工程师的。 P&gt; </p><p>你的问题是,软件工程师创建一个系统,该系统工程师将不得不使用,并且该软件工程师创建从一无所有的功能寓意什么是有点令人惊讶,略可怕。你应该格外小心使用含有带您的软件工程师来定义的功能;它们应该被执行指定的功能(以及说明书应当什么所使用的系统工程师)。 P&gt;
    </p>

    韩乐克

相关信息

电子商务 VS 网络工程师

请问一下现在这二职业那个比较吃香呀 网络工程师主要做什么事呀?? 以后这二职业哪个会比较好 大哥们快发表一下意见!

85 浏览 1 回复   电子商务   电子   商务   网络   职业  

软件工程师应该有多少种语言学习? [关闭]

<p>有多少种语言应的软件工程师需要学习?我是乙的Tech 2的学生,我只有C的知识,请告诉我其他语言和课程,其中软件工程师的需求。 P&gt; </p>

29 浏览 1 回复   gt   语言   li   em   编程  

网络工程师 网络安全工程师的问题!懂的进1

网络工程师主要是干什么的?工资多少?华为的网络工程师证好考吗? 网络安全工程师!是干什么的?工资多少?证好考不? 还有!网络工程师要怎么才能算是一个网络工程师!? 要学什么?

30 浏览 3 回复   网络   系统   知识   工程师   工程  

C#在源文档生成非程序员

<p>软件组我目前的工作在最近决定开始记录我们的代码库。最初的办法,他们已采取了使用内置的三斜杠///文档化的方法。 P&gt; </p><p>一个新的问题,我们开始发现的是,通过doxygen的运行此的结果是代码库的一个很不错的表现,但对于一个程序员使用,我们本来打算这个文件是由我们的系统工程师可读谁都会经常到我们这里来问什么任务做完全是。 P&...

40 浏览 1 回复   一个   文档   工程   使用   gt  

3D MAX和MAYA能不能考级,或是认证,工程师之类的

现在在学3D MAX ,听说有灯光工程师和材质工程师可以考,不知道在哪里考,怎么考,啥时候考。MAYA听说有认证,好象很难考啊,有没有哪个大师级的考过的给传授一下经验啊。感激不尽呀

67 浏览 5 回复   认证   证书   国际   地区   软件