.NET开发 程序员必备工具 -- NDoc:创建代码文档工具

  编写代码文档资料几乎总是一项令人畏惧的任务。我所说的不是早期设计文档,甚至也不是更为详细的设计文档;我说的是记录类上的各个方法和属性。 NDoc 工具能够使用反射来分析程序集,并使用从 C# XML 注释生成的 XML 自动为代码生成文档资料。XML 注释仅适用于 C#,但有一个名为 VBCommenter 的 Visual Studio .NET Power Toy,它能够为 Visual Basic .NET 完成类似的工作。此外,下一版本的 Visual Studio 将为更多语言支持 XML 注释。

  使用 NDoc 时,你仍然在编写代码的技术文档,但你是在编写代码的过程中完成了文档编写工作(在 XML 注释中),而这更容易忍受。使用 NDoc 时,第一步是为你的程序集打开 XML 注释生成功能。右键单击该项目并选择 Properties | Configuration Properties | Build,然后在 XML Documentation File 选项中输入用于保存 XML 文件的路径。当该项目生成时,将创建一个 XML 文件,其中包含所有 XML 注释。下面是 NUnit 示例中的一个用 XML 编写了文档的方法:

/// <summary>
/// This test adds a number of values to the Hashtable collection 
/// and then retrieves those values and checks if they match.
/// </summary>
[Test]
public void HashtableAddTest()
{
//Method Body Here
}
  有关该方法的 XML 文档资料将被提取并保存在 XML 文件中,如下所示:

<member name="M:NUnitExample.HashtableTest.HashtableAddTest">
<summary>

时间: 2024-09-25 06:28:41

.NET开发 程序员必备工具 -- NDoc:创建代码文档工具的相关文章

优秀程序员必备的一些素质

中介交易 http://www.aliyun.com/zixun/aggregation/6858.html">SEO诊断 淘宝客 云主机 技术大厅 作为一个合格而优秀的程序员,应该具有哪些素质?其实才工作半年的我,好像远远不够资格来谈论这个话题,不过这半年的成长让我获益匪浅,在程序员这个话题上也可以多多少少说出一点有价值的东西来. 一.对开发工作要有必要的兴趣 兴趣是最好的老师,对某个事物有了一定的兴趣,才会潜下心来学习.研究它,工作同样如此.如果对程序员的工作完全没有兴趣,甚至是抱着厌

合格的PHP程序员必备技能_php技巧

作为PHP的爱好者,如果你想加入PHP程序的世界,一定要做好充分的准备. 如果想进入大的企业进行底层开发的话必须对互联网各方面的技术原理了解的很清楚,例如apache实现原理.语言方面既然是php开发自然对 c/c++要求比较高.往往需要自己写php扩展.使用mysql自然想很多常见的,性能瓶颈要能有很好的解决方案.mysql 插件编写,apache模块编写.联系起来结合点还是要会c. 倘若是做中间层和前端工作则要求对css,javascript要求比较高.当然对web的一系列实现原理也是要非常

整理类库-新手Net开发程序员想知道如何整理C#类库?

问题描述 新手Net开发程序员想知道如何整理C#类库? 刚工作不久带我的师父在做框架,让我帮忙整理类库,我不知道如何下手,求有经验的大神指导一下(最好能具体告知整理类库的步骤和注意事项)谢谢了

java后台开发程序员要怎样测试

问题描述 java后台开发程序员要怎样测试 一个刚入职的菜鸟,公司的一个项目的功能已经实现的差不多了,临时添加了一个小功能,不过只有一级页面,二级页面还没出来,所以老大让我先实现后台,写后台代码,写完后想要检测一下我写的方法对不对,但是不知道怎样测试,公司用的是SSH框架,使用了junit单元测试,生成测试类时出现了这样 package cn.itcast.erp.auth.menu.web; import static org.junit.Assert.*; import org.junit.

程序员必备的10大健康装备! 我们要工作更要健康!_生活健康

前言 做为程序员,为了实现理想而奋斗不懈,每天对着电脑辐射坐在工位上拼搏8小时甚至更久,这种如同机器旁边的机器般的工作对于健康的损耗何其之大?再这么下去,还真得应了:"职务不高,工资不高,血压血脂血糖高:政治不突出,业务不突出,腰椎盘突出"这种亚健康状态,最可怕的是技术人员平均寿命都有点惊悚,就怕最后"出师未捷身先死,长使英雄泪满襟".是时候呼吁一下健康的问题了!废话不说了,进入正题吧.本次的带来的是:程序员必备的10大健康装备,Let's go! 装备1:沙袋 &

十个程序员必备的网站推荐

简述 程序员的工作和日常生活非常的枯燥,这里给大家推荐一些程序员经常使用的网站,也是我经常上的一些网站,尤其是前三个网站感觉用起来非常的舒服.我大致把这些网站分为三类,使用工具类,设计分享类,资讯交流类,业界良心类.希望能对大家有所帮助. 简述 网站推荐 网站推荐 Github代码托管(https://github.com/) 作为开源代码库以及版本控制系统,Github拥有140多万开发者用户.随着越来越多的应用程序转移到了云上,Github已经成为了管理软件开发以及发现已有代码的首选方法.代

程序员必备的 17 款强有力武器,你拥有几个!

对于每一位开发者而言,软件工具的重要性显然不言而喻.事实上,除了个人能力之外,它们也在团队的效率及实际生产力层面扮演着关键性角色.在今天的文章中,我们整理出17款最为强大的开发武器,如果您尚未尝试过其中部分工具,请务必予以关注. 1.Terminal(终端) 虽然根据开发方向的不同,大家对终端的依赖程度亦有所区别,但必须承认我们或多或少要与其打交道. 在终端中,大家可以通过命令执行各类进程.只需要一条命令,我们即可完成自己需要的操作--而无需在多个菜单间来回切换. 2. Tmux 在处理多进程与

资深web开发程序员建站经验分享

web|web开发|建站|经验分享|程序员 我的历程:C - C++ - HTML - ASP - ASP.NET -JSP - PHP - XHTML(DIV+CSS) - 美工 设计工具:...(非web语言的不算了) - DreamWeaver + Editplus + Eclipse(JSP的时候) + ZEND(PHP时代) + PS(美工设计时代) 不知道有没有人和我类似现在做网站策划规划比较多点,主要在网站设计方面,讲究简为美的观点.现在写代码直接用EDITPLUS了,包括页面和C

Sublime Text[崇高文本]----最性感的编辑器(程序员必备)

代码编辑器或者文本编辑器,对于程序员来说,就像剑与战士一样,谁都想拥有一把可以随心驾驭且锋利无比的宝剑,而每一位程序员,同样会去追求最适合自己的强大.灵活的编辑器,相信你和我一样,都不会例外. 自打开始编程,我就开始试过不少编辑器,比如editplus,ultraedit,emacs,vim,还有各种各样不同的IDE,但却没有哪款让我特别心仪的,直到我遇到了 Sublime Text 2 !如果说"神器"是我能给予一款软件最高的评价,那么我很乐意为它封上这么一个称号.它小巧绿色且速度非