VS2005代码文档生成

 在VS2003里可以方便的使用NDOC生成代码文档，但NDOC不支持2005，所以只能用其他方法了。微软官方的文档生成工具Sandcastle+htmlhelp非常强大，不过是命令行的，使用不大方便。不过有人写了GUI，例如SandcastleGui和Sandcastle help File Builder( 用过比较好用)。

Sandcastle+Html work shop + Sandcaste help file builder使用：

1.  下载Sandcastle(TCP),HTML Work Shop,Sandcastle Help File Builder 并安装。

http://www.microsoft.com/downloads/details.aspx?FamilyId=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp

http://www.codeplex.com/SHFB

2.  生成文档.

      。首先要为项目生成一个XML文件,在VS2005的C#项目--属性--生成--项中勾选XML documentation file,设置XMl文件名,设置完毕，再次生成该项目，就可以生成属于它的XML文件了。

     。然后打开我们已经安装好的Sandcastle Help File Builder并对它进行设置

     。点击Add按钮，选中项目生成的exe,dll,xml文件

     。保存该项目后点击Namespaces按钮，选中想要生成帮助文档的Namespace

     。设定Dependencies选项，把项目中所引用到的dll文件加载进去

     。设置HtmlHelp1xCompilerPath为HTML Help Workshop的安装路径，设置SandcastlePath为Sandcastle的安装路径

     。设置文档的输出路径OutputPath,默认输出路径在项目所在目录的Help文件夹下

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

       经过以上步骤，您就可以成功的为您的项目生成帮助文档了。

本文来自CSDN博客，转载请标明出处：http://blog.csdn.net/dreambroken/archive/2007/07/26/1709594.aspx