VS2005代码文档生成 :Sandcastle
2007-08-16 14:38
225 查看
在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)即可生成所需的帮助文档
经过以上步骤,您就可以成功的为您的项目生成帮助文档了。
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)即可生成所需的帮助文档
经过以上步骤,您就可以成功的为您的项目生成帮助文档了。
相关文章推荐
- 使用SandCastle生成代码注释文档
- .net中使用Sandcastle(类似java中的jdoc)生成代码帮助文档
- 使用 Sandcastle 生成代码帮助文档
- 使用 Sandcastle 生成代码帮助文档
- 通过代码XML注释与Sandcastle生成SDK文档(进阶篇)
- vs2010代码注释自动生成api文档(Sandcastle帮助文档生成器使用介绍)
- VS 2005设计器自动生成的界面代码,贴在这里自己做参考.
- C#项目程序员文档自动生成-----Sandcastle
- java将文档转换成html页面代码 (doc中的图片生成资源文件)
- win32汇编入门了解(3)VS生成的代码里面的几个常见的基本伪指令
- PhpDocumentor生成代码说明文档
- Sphinx将python代码注释生成文档
- 使用Sandcastle生成CHM帮助文档
- C#生成Word文档代码示例
- (VC++6.0 )基于单文档对话框的自动生成代码注释
- php将数据库中所有内容生成静态html文档的代码
- 为VS.NET 2005增加Atlas Scripts的代码提示功能
- 使用GhostDoc为代码生成注释文档
- 使用PDFLib生成PDF文档,C代码实例--画图形
- AutoCode (vs插件)自动生成代码插件 下载及使用教程(C#版)