使用 Sandcastle Help File Builder 制作文档

 

1.下载安装 Sandcastle 程序。

http://download-codeplex.sec.s-msft.com/Download/Release?ProjectName=shfb&DownloadId=1408995&FileTime=130655702941330000&Build=21029

2.在程序中使用批注将代码注释说明清楚。

标记	说明
<event>	对某个成员可能引发的事件的说明。
<example>	“示例”，帮助类库使用者理解类型/成员使用方法的示例代码。
<exception>	对某个成员可以抛出的异常的说明。
<exclude/>	指示 NDoc 文档引擎将被标记的类型/成员排除在代码文档之外。 与文档引擎的“可见性”配置不符的，以 exclude 优先。
<include>	将代码文件外部的某 XML 文件中的一部分包含进代码文件来。
<overloads>	为“重载列表”页面准备摘要、备注、示例等文档内容。只需在重载成员的第一个成员前面书写此区域即可。 <overloads> 标记有两种形式: 简单的形式，直接在 overload 中写文本，这些文本被处理为“重载列表”页面的摘要。没有备注、示例等区域。 复杂的形式，在 overload 内部，包含 summary, remarks, example 等标记分别表示“重载列表”页面的摘要、备注、示例等。 示例: ///<overloads>This method has two overloads.</overloads> ///<summary>This overload just says hello.</summary> public void SayHello() { ... } ///<summary>This one says hello to someone.</summary> public void SayHello(string toSomeone) { ... }
<param>	成员的参数说明。
<permission>	访问某成员所必需的 .NET Framework 安全性 CodeAccessPermission。
<preliminary>	将某类型/成员标记为“预发布”。内部的文本被当作警告文本用红色显示，可以包含 <para> 表示多行文本。如果缺少内部文本，则显示默认的警告文本: “[此文档为预发布版本，在未来版本中有可能改变。]”。 如果需要把全部类型/成员都标记为“预发布”，请使用文档引擎的 Preliminary 配置项。
<remarks>	“备注”，对 <summary> 的进一步注解。
<returns>	“返回值”。
<seealso>	向页面的“请参见”区域添加一个链接。 请不要将此标记包含在 <remarks> 内部，它是一个顶级标记。 两种可选的语法: <seealso href="http://www.microsoft.com/china/msdn/">MSDN(CHS)</seealso> <seealso cref="System.Data.DataSet">DataSet</seealso>
<summary>	“摘要”，对类型/成员的摘要说明。
<threadsafety>	“线程安全”，说明类型在多线程环境中是否安全。 NDoc 提供 static 和 instance 两个布尔的属性，可以自动生成像 .NET Framework SDK 类库文档中那样的标准文本。 threadsafety 标记内部可以包含额外的文本，会被显示到标准文本的下方，说明额外的信息。例如: /// <summary>The summary description for SafeClass.</summary> /// <threadsafety static="true" instance="true"> ///    <para>More information about using this class across thread</para> /// </threadsafety> public class SafeClass() { ... }
<value>	“属性值”。

 

3.编译生成项目，启用 Sandcastle Help File Builder ，将编译后的项目添加到Documentation Sources 。

4.Build the help file,完成。