试用NDoc生成开发文档

原创 2004年08月16日 13:21:00
     完成了工单实施的编码,但设计文档并没实时更新,现在领导说要设计文档,天啊!那么多的类,函数、属性说明都要自已
写??
 前两天正好看了《每个 .net 开发人员现在应该下载的十种必备工具》中有个NDoc生成文档,何不试试??
 下载安装完,会直接在开始-->程序下添加一执行文件链接:nDoc,打开,初始界面如下:

o_NDoc.JPG

弄了半天也不知道怎么加载程序集,原来是在生成程序集时要生成对应的XML文件才行。在VS.NET项目上点击右键-->属性-->生成
XML文档文件上输入要生成的XML文件名,则VS.NET在生成时会默认生成对应的XML文件。
  点击NDoc中的"Add"按键,输入待生成文件的程序集名,和对应的XML文件名,即可装载程序集
  之后可设置生成文件类型,可生成MSDN格式的文档(像MSDN文件格式,默认采用此格式),XML文档等,还可设置在生成文档标题,版权
信息等等。(对中文支持不是很好,如果生成文档名称为中文可能会出现乱码,产生错误!)
  点击工具栏上的“Build"按键,不出几分钟,文档即自动生成.
  点击工具栏上的“View”按键,可调出生成的编译好的HTML帮助文件。

o_Implement's%20Help.JPG

收藏助手
不良信息举报
您举报文章:试用NDoc生成开发文档
举报原因:
原因补充:

(最多只允许输入30个字)