SHFB-Sandcastle Help File Build vs文档生成工具安装及配置
来源:互联网 发布:java项目开发案例书籍 编辑:程序博客网 时间:2024/05/18 01:43
SHFB-Sandcastle Help File Build vs文档生成工具安装及配置
1 该软件使用较简单,列出重要步骤,部分省略
2 软件安装
2.2.1 安装包SHFBGuidedInstaller_2014.5.31.0.zip 下载地址 http://download.csdn.net/detail/huwei2003/9531584
2.2.2 安装
点击SandcastleInstaller.exe 按提示安装即可
3 软件使用
3.1.1 前提要求第一:把生成帮助的工程的属性做下修改,右键工程,属性,生成,下面的输出框中有一个生成XML文件选项,打勾。文件会把工程中所有类,方法,属性上的注释保存下来。
第二:属性的注释。这个是最简单的,一般有summary块就行了,其中有一个value块,可以针对默认值进行描述。方法,接口的注释类似,在summary块对方法的用途,参数进行说明。
如下:
/// <summary>
/// 方法说明
/// </summary>
/// <param name="arg1">参数说明</param>
/// <returns>返回说明</returns>
/// <remarks>
/// 备注
/// </remarks>
/// <example>
/// <code>
/// 如何调用举例
/// </code>
/// </example>
public string GetString(string arg1)
{
...
}
3.1.2 建立工程
3.1.2..1 Build 项设置
3.1.2..2 Help File 设置
设置相应信息即可
3.1.2..3 Help1/Website 设置
设置相应信息即可
3.1.2..4 MS Help 2设置
无须设置
3.1.2..5 MS Help Viewer
无须设置
3.1.2..6 Summaries
无须设置
3.1.2..7 Visibility
这里可以定义你要生成文档的方法定义,哪些要生成,哪些不要生成,下面的edit api filter 可以设置更详细的内容,如哪个命令空间下的不要生成,哪个类的不要生成,勾选上的是要生成的
3.1.2..8 Missing Tags
设置相应信息即可
3.1.2..9 Paths
1 在右上角 点击 documentation sources 添加要生成文档的源工程 ,选择对应的dll,文件.如下图:
2 设置文档输出路径,及工作临时路径,如上图;
3.1.2..10 Commponents
3.1.2..11 Plug-Ins
无须设置
3.1.2..12 Transform Args
无须设置
3.1.2..13 Transform Args
无须设置
3.1.2..14 User Defined
无须设置
3.1.2..15 Build Events
无须设置
3.1.3 生成
设置完成后,点击Documenttation – build project即可生成文档
生成的文档大致如下图
非常好的一点是 生成的项目文件 webapi.shfbproj 可以在teamcity(自动构建工具)中利用MSBuild 来自动生成文档,teamcity的介绍将在另一篇中介绍。
0 0
- SHFB-Sandcastle Help File Build vs文档生成工具安装及配置
- .Net 2.0 的文档生成器 Sandcastle Help File Builder
- C# CHM帮助文档生成工具-Sandcastle
- Sandcastle----强大的C#文档生成工具
- 文档生成工具Sandcastle的使用
- Sandcastle----强大的C#文档生成工具
- Sandcastle----强大的C#文档生成工具
- .net下帮助文件生成程序对比(NDoc、Sandcastle、Sandcastle Help File Builder)
- sandcastle , HTML Help Workshop, Sandcastle Help FIle Builder 出错经验总结
- Sandcastle生成项目文档
- Sandcastle生成帮助文档
- Sandcastle生成帮助文档
- 一个生成.net api文档的工具sandcastle
- [转]Sandcastle----强大的C#文档生成工具
- VS2005代码文档生成 :Sandcastle
- Sandcastle生成CHM帮助文档
- Sandcastle Help File Builder[Missing <summary> documentation for ""]
- .NET项目工程生成一份项目帮助文档chm--Sandcastle工具
- Qualcomm Hexagon DSP入门篇之开始连接:fastRPC技术
- android开发 使用Action启动/关闭Service
- 通过css去除安卓浏览器标签选中时候的边框
- 【转载】设计模式六大原则
- C# 调用DllImport
- SHFB-Sandcastle Help File Build vs文档生成工具安装及配置
- 数字PID
- android网络连接的判断
- ubuntu14.10 + sublime text 3编译qt4程序
- 黑马程序员认识List和Set集合
- Linux - nmon - IBM系统监控工具nmon使用说明(1)
- JS中正则表达式只有3种匹配模式(没有单行模式)
- 最全的Eclipse快捷键
- log4j.properties配置详解