天天看点

使用SandCastle创建.Net帮助文档

我们创建一个简单的ClassLibrary1项目最为示范:

代码很简单,注意其中的XML注释。

打开项目的属性,在“Build”选项中,确保“XML documentation file:”被选中了。

<a href="http://images.cnblogs.com/cnblogs_com/DotNetNuke/WindowsLiveWriter/SandCastle.Net_92F4/image_2.png"></a>

使用SandCastle创建.Net帮助文档

打开Sandcastle Help File Builder并新建一个项目:

使用SandCastle创建.Net帮助文档

为Sandcastle Help File Builder项目添加编译生成的DLL文件,右键点击项目右边的“Documentation Sources",选择“Add Documentation Source...”

使用SandCastle创建.Net帮助文档

选择刚刚生成的DLL文件。

使用SandCastle创建.Net帮助文档

在项目的属性窗口,你可以根据需要修改一些设置。

<a href="http://images.cnblogs.com/cnblogs_com/DotNetNuke/WindowsLiveWriter/SandCastle.Net_92F4/image_16.png"></a>

使用SandCastle创建.Net帮助文档

点击Build the help file来生成文档。

这是最终生成的文档:

使用SandCastle创建.Net帮助文档