.net 2.0 文档生成工具
.net 2.0 文档生成工具
电子科技大学软件学院03级02班 周银辉
1, 没有NDoc的日子
在.Net1.1时ndoc用于文档生成很有用, 但可惜的是其目前并不支持.Net2.0. 这让人多少有些郁闷.
苦苦寻觅之后找到了以下支持.Net2.0文档生成的工具, 相当不错.
2, Sandcastle + HTML Work Shop + Sandcastle Help File Builder
2.1看看效果:
2.2 下载以下工具并安装:
Sandcastle http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en
HTML Work Shop http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp
Sandcastle Help File Builder http://www.codeproject.com/useritems/SandcastleBuilder.asp
2.3 让Visual Studio 自动生成注释的XML文档
在c#项目,打开项目属性页，鼠标左键点击Build项，在显示的页面中勾选XML documentation file。 重新生成项目，就可以生成属于它的XML文件了。
2.4 运行安装好的Sandcastle Help File Builder:
2.4.1 点击Add按钮，选中项目生成的exe,dll,xml文件(添加完毕后检查一下是否有被重复添加的,去掉重复的)
电子科技大学软件学院03级02班 周银辉
1, 没有NDoc的日子
在.Net1.1时ndoc用于文档生成很有用, 但可惜的是其目前并不支持.Net2.0. 这让人多少有些郁闷.
苦苦寻觅之后找到了以下支持.Net2.0文档生成的工具, 相当不错.
2, Sandcastle + HTML Work Shop + Sandcastle Help File Builder
2.1看看效果:
2.2 下载以下工具并安装:
Sandcastle http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en
HTML Work Shop http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp
Sandcastle Help File Builder http://www.codeproject.com/useritems/SandcastleBuilder.asp
2.3 让Visual Studio 自动生成注释的XML文档
在c#项目,打开项目属性页，鼠标左键点击Build项，在显示的页面中勾选XML documentation file。 重新生成项目，就可以生成属于它的XML文件了。
2.4 运行安装好的Sandcastle Help File Builder:
2.4.1 点击Add按钮，选中项目生成的exe,dll,xml文件(添加完毕后检查一下是否有被重复添加的,去掉重复的)
2.4.2 保存该项目后点击Namespaces按钮，选中想要生成帮助文档的Namespace, 并在文本框中输入对该名字空间的注释
2.4.3 设定Dependencies选项，把项目中所引用到的dll文件加载进去(注意,也要包含System,System.Windows.Forms等全局程序集,
如果有依赖项未添加,在Output窗口中会有错误提示)
2,4,4 设置HtmlHelp1xCompilerPath为HTML Help Workshop的安装路径，
2.4.5 设置SandcastlePath为Sandcastle的安装路径
2.4.6 最后点击顶头菜单Documentation下拉菜单中的Build Project选项（或直接使用快捷键Ctrl+Shift+B）即可生成所需的帮助文档
