利用Sandcastle快速生成一个源代码的帮助文档
2011-01-06 10:56
531 查看
1.安装Sandcastle(Version 2.6.1062.1)和SandcastleBuilder(SHFB v1.9.1.0 Release )
2.将源代码的项目,进行设置,"生成"—"XML文档文件"打钩
3.运行SandcastleBuilder安装出来的"Sandcastle Help File Builder GUI"。"Documentation Sources"右键点击"Add Documentation Source..."添加目标解决方案的sln
4."Sandcastle Help File Builder GUI"的"Project Properties"中"Paths"中"OutputPath"设置输出帮助文档的文件目录
5.点击"Documentation"菜单中的"Build Project",SandcastleBuilder会自动生成出一个CHM文档,耗时较长。
注意:
1.注释的编写,参照:建议的文档注释标记(C# 编程指南)
2.项目一定要生成xml文档文件,虽然编译过程中会有未做注释的警告。
SandcastleBuilder常用设置:
Build
FrameworkVersion:设置sln的.net版本
Help File
HelpTitle:CHM文件的标题名
HtmlHelpName:CHM文件的文件名
Paths
OutputPath:CHM文件输出的目录
2.将源代码的项目,进行设置,"生成"—"XML文档文件"打钩
3.运行SandcastleBuilder安装出来的"Sandcastle Help File Builder GUI"。"Documentation Sources"右键点击"Add Documentation Source..."添加目标解决方案的sln
4."Sandcastle Help File Builder GUI"的"Project Properties"中"Paths"中"OutputPath"设置输出帮助文档的文件目录
5.点击"Documentation"菜单中的"Build Project",SandcastleBuilder会自动生成出一个CHM文档,耗时较长。
注意:
1.注释的编写,参照:建议的文档注释标记(C# 编程指南)
2.项目一定要生成xml文档文件,虽然编译过程中会有未做注释的警告。
SandcastleBuilder常用设置:
Build
FrameworkVersion:设置sln的.net版本
Help File
HelpTitle:CHM文件的标题名
HtmlHelpName:CHM文件的文件名
Paths
OutputPath:CHM文件输出的目录
相关文章推荐
- [转]利用Sandcastle制作源代码的帮助文档1
- [转]利用Sandcastle制作源代码的帮助文档2
- [转]利用Sandcastle制作源代码的帮助文档3
- 利用Sandcastle制作源代码的帮助文档2
- Doxygen学习笔记(0)- 利用Doxygen快速生成帮助文档
- 利用源代码生成struts2.3.1.2帮助文档(授之以渔)
- 利用Sandcastle制作源代码的帮助文档1
- 让Sandcastle为你的类库生成类似于MSDN的帮助文档
- Struts2-如何通过源代码生成帮助文档
- 使用 Sandcastle 生成代码帮助文档
- 使用Sandcastle工具为.NET项目工程生成一份项目帮助文档chm
- 使用Sandcastle Styles 来生成VS2008的帮助文档.
- 使用 Sandcastle 生成 chm 帮助文档
- 让Sandcastle为你的类库生成类似于MSDN的帮助文档
- 一个利用google文档快速解决docx向doc转换的问题
- C#制作源代码的帮助文档 chm帮助文档 C#类库帮助文档生成
- vs2010代码注释自动生成api文档(Sandcastle帮助文档生成器使用介绍)
- 让Sandcastle为你的类库生成类似于MSDN的帮助文档
- android UiAutomator利用快速调试生成excel文档测试报告
- 使用Sandcastle生成CHM帮助文档