NDoc简介

本文介绍如何使用NDoc为.NET项目生成专业的API文档。通过在代码中添加特定格式的注释,NDoc能够自动生成包括JavaDoc、MSDN-thml等多种格式的文档。文章详细讲述了配置步骤,并提供了一些实用技巧。
摘要由CSDN通过智能技术生成

1、NDoc的作用
他可以将我们在代码编写过程中使用///形成的XML的注释,自动形成多种风格的类库文档。这些风格可以是JavaDoc,MSDN-thml,MSDN-chm,XML等。让我们快速拥有专业级的类库API 文档
 
2、NDoc的获得
NDoc是一个开源项目,由于MS打算要做类似的东西(sandcastle ),作者放弃了后续的开发,其版本停留在1.3X。MS的sandcastle 还是很不好用,而且目前只有控制台界面。NDoc其下载地址如下:
http://ndoc.sourceforge.net/
 
好在有一些好事之徒,继续对它的研究提供了其对.Net 2.0的支持。并且做了汉化其下载地址如下:
http://www.rainsts.net/article.asp?id=382
 
3、NDoc1.3.1中文版For .Net 2.0的使用
 
a、在源代码中加入注释。必须是使用///进行的注释
b、设置项目输出XML文档及其路径。(必须的)
c、生成程序集。
d、打开NDoc,添加要生成文档的程序集。或者添加解决方案程序自动分析出程序集。
e、选择文档引擎(MSDN,XML.....)
f、进行一些设置(也可以使用默认的设置)
g、生成文档
h、查看效果
 
4、注意事项
a、NDoc默认设置对访问控制是public的东东进行处理。我在试验的时候类没有加Public关键字,折腾很久才发现原因。
b、一定要设置生成XML文档,NDoc依赖这个东西
c、NDoc的设置项可以进行修改。比如你可以允许Internal的东东被输出。使用 class Customer,这样定义的类就可以有注释。
d、NDoc还增加了一些自己的标签。比如<example>,举例说明如何使用。
e、中文的用户指南
http://www.percyboy.com/w/ndoc/userguide.aspx
 
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值