.Net 2.0 文档生成工具

Sandcastle + HTML Work Shop + Sandcastle Help File Builder

1看看效果:

doc.PNG

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

3 让Visual Studio 自动生成注释的XML文档
在c#项目,打开项目属性页,鼠标左键点击Build项,在显示的页面中勾选XML documentation file。 重新生成项目,就可以生成属于它的XML文件了。

4 运行安装好的Sandcastle Help File Builder:


4.1 点击Add按钮,选中项目生成的exe,dll,xml文件(添加完毕后检查一下是否有被重复添加的,去掉重复的)
4.2 保存该项目后点击Namespaces按钮,选中想要生成帮助文档的Namespace, 并在文本框中输入对该名字空间的注释

4.3 设定Dependencies选项,把项目中所引用到的dll文件加载进去(注意,也要包含System,System.Windows.Forms等全局程序集,

如果有依赖项未添加,在Output窗口中会有错误提示)

4,4 设置HtmlHelp1xCompilerPath为HTML Help Workshop的安装路径,

4.5 设置SandcastlePath为Sandcastle的安装路径

4.6 最后点击顶头菜单Documentation下拉菜单中的Build Project选项(或直接使用快捷键Ctrl+Shift+B)即可生成所需的帮助文档

转载于:https://www.cnblogs.com/yoshow/archive/2007/06/04/770200.html

    程序的注释在程序的编写和维护中扮演着相当重要的角色,在生成工程的同时,说明文档也随之而生了。.net 文档生成工具用于将xml 文档注释生成格式类似MSDN的HTML帮助文档,并编译为CHM文档。(下文中将该工具称为ADB,该软件仅测试过.net2.0的程序集) .NET文档生成工具下载  .net文档生成工具2.1下载 .net文档生成工具2.0下载  .net文档生成工具1.0下载  源代码下载 .net 文档生成工具2.1源代码下载 相关连接 编写文档生成器(ADB2.0) 编写文档生成器(ADB2.1) 各版本说明 版本2.1.0.0 1.增加检测更新功能; 2.修改加载文档生成器的方式; 2.增加检测文档生成器版本的功能。   版本2.0.0.0 1.修正1.0中有时加载程序集错误的Bug; 2.增加自定义文档生成器的功能。   版本1.0.0.0: 1、合并多个程序集; 2、自动搜索程序集及其引用的程序集对应的XML文档(包括.Net自带的程序集,如:system.xml); 3、控制在文档中显示哪些成员,支持批量选择(如:选择所有公共的方法);  4、提供一个CHM文档生成器,用于生成类似MSDN的HTML文档,并编译成CHM文档,该文档生成器支持以下注释标注:     <code> <param> <example> <summary> <exception> <remarks> <return> <value>     <code>扩展了3个属性:src-用于指定存放代码的文件,encoding-指定文件的编码,language-代码使用的语言,例如:     <code language="C#" src="code.cs" encoding="GBK">   使用方法 1.步骤: (1) 点击添加,选择要生成文档的程序集; (2) 选择将在文档中显示该成员; (3) 输入标题,点击创建文档。   2.主界面:   3.批量选择界面:
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值