NDOC和Sandcastle两款工具都可以将C#中的XML注释生成类似MSDN的文档。
NDOC是一款开源的文档生成工具,在asp.net1.1就已经在使用,但官方却一直没有发布针对.net2.0的版本(网上可以google到网友自己修改过针对.net2.0版本)
http://www.percyboy.com/w/ndoc/
让 NDoc 1.3 支持.NET 2.0 程序集,泛型输出和 Visual studio 2005 解决方案导入
Sandcastle为今年微软官方发布的文档生成工具,不过暂时没有UI,只能在命令行模式下操作。
Sandcastle June CTP的下载地址http://www.microsoft.com/downloads/details.aspx?FamilyID=e82ea71d-da89-42ee-a715-696e3a4873b2&DisplayLang=en
SandcastleGUI.exe (非官方的Sandcastle界面工具)
http://www.inchl.nl/SandcastleGUI/
NDOC使用过程中的问题
1。在Chm中连接图片或其他文件
如果要在文档中连接图片或其他文件,则首先要在注释中加<img src="" width="" height=""></img>
- src只输文件名即可,如 :src="function.jpg",这个路径是代表文件在Chm内部的路径,而不是文件所在的物理路径。
然后在NDOC中的设置FileToInclude选项,将代码中用到的文件添加到Chm内部。
如:
- 单个 d:\xxx\channel\vip\function.jpg
- 多个 d:\xxx\channel\vip\function.jpg|d:\xxx\channel\vip\function_2.html
Sandcastle使用过程中的问题
1.关于生成的文档的中文乱码问题:
因为Sandcastle默认的模板xsl文件中没有指定生成的html文件的编码,所以在浏览中文时就会出现乱码。
解决办法就是在模板文件中加入<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />。