一、Sandcastle
这个是 c#类库方法根据注释生成帮助文档的工具,我们经常会遇到把 DLL 或者
API 提供给别人调用的情况,通过在方法中添加注释,然后再用 Sandcastle 来自
动生成文档给调用者,如下图:
图 1:这是 Sandcastle Help File Builder 软件界面
图 2:这是生成的 chm 文档
Sandcastle(包含一个25页的使用文档) 这个是c#类库方法根据注释生成帮助文档的工具,我们经常会遇到把DLL或者API提供给别人调用的情况,通过在方法中添加注释,然后再用Sandcastle 来自动生成文档给调用者,如下 单纯Sandcastle好像是没有界面的, 这个链接提供的下载可以包含图形界面。 注意:如果需要生成chm还需要微软的 MicrosoftHTMLHelpWorkshop 支持,Sandcastle生成时会自动去查找MicrosoftHTMLHelpWorkshop 的安装目录。 安装: 安装很简单,两个软件都只需要直接点击“下一步”即可安装完成。 默认情况下dll中所有方法和属性都会生成对应文档,也可以根据自己需要只把DLL中需要的类或方法生成文档,