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,完成。

使用 Sandcastle Help File Builder 制作文档的更多相关文章

  1. 使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档

    使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档 下载地址:http://sandcastle.codeplex.com/ 下载地址2:http:// ...

  2. Sandcastle Help File Builder(.NET帮助文档工具)的版本选择心得——支持VS2010至VS2015,高版本项目文件问题

    作者: zyl910 一.缘由 "Sandcastle Help File Builder"(简称SHFB)是一个很好用.NET 帮助文档生成工具. 但它的每个版本支持的VS版本范 ...

  3. Sandcastle Help File Builder 生成NET帮助文档

    Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具,目前是在CodePlex上的一个开源项目,可以去这里下载:Sandcastle Sandcastle生成的输出结果具有 ...

  4. 文档生成工具Sandcastle Help File Builder

    Sandcastle Help File Builder   http://shfb.codeplex.com/

  5. Sandcastle Help File Builder使用教程

    Sandcastle Help File Builder相信很多的园友用过,小弟我最近因为工作原因需要生成公司的一套SDK的帮助文档,因此找了一些资料,发现网上的资料很多,但是都不怎么完全,有些只是随 ...

  6. 如何制作dll库的API文档,自动生成微软风格的chm文件 Sandcastle Help File Builder 使用方法

    当你开发了一个库的时候,就需要给库开发一个api文档,微软提供了一个C#库的自动生成工具.我在使用的过程中记录了相关的信息,以供大家学习和查阅,如有不正之处,欢迎指出. 首先先下载一个软件,下载地址在 ...

  7. sphinx+reStructuredText制作文档

    1 spinx简介 Sphinx 是一种文档工具,它可以令人轻松的撰写出清晰且优美的文档, 由 Georg Brandl 在BSD 许可证下开发. 新版的Python文档 就是由Sphinx生成的,并 ...

  8. Use Sandcastle Help File Builder to generate help document

    http://shfb.codeplex.com/ Note: If the the help file contains the text "[Missing <param> ...

  9. Oracle-在线重定义操作文档

    Oracle-在线重定义操作文档 2015年10月8日 15:51 在线重定义的大致操作流程如下: (1)创建基础表A,如果存在,就不需要操作. (2)创建临时的分区表B. (3)开始重定义,将基表A ...

随机推荐

  1. 虚拟机安装的ubuntu不能联网解决

    安装双系统从没遇到的问题,再虚拟机上遇到了不能联网的问题: 下面给出我的解决方法(win10系统.ubuntu 16.04) 我的电脑-管理-设备管理器 看是否虚拟机的虚拟网卡在: 在去设置-控制面板 ...

  2. C#中对虚拟属性和抽象属性的重写有什么异同

           public abstract class A         {             //抽象属性不能有实现代码             public abstract strin ...

  3. 1.3 eclipse快捷键

    来源:http://blog.csdn.net/dashuxiaoai/article/details/8737928 另:Eclipse快捷键 10个最有用的快捷键  http://www.cnbl ...

  4. 洛谷P1130红牌(简单DP)

    题目描述 某地临时居民想获得长期居住权就必须申请拿到红牌.获得红牌的过程是相当复杂 ,一共包括NNN个步骤.每一步骤都由政府的某个工作人员负责检查你所提交的材料是否符合条件.为了加快进程,每一步政府都 ...

  5. new一个对象做了哪些操作

    网上其实有很多说new关键字做了哪些操作,读过之后就忘了,这里以自己的理解做一个简单的记录. function Naji () { this.skulk = function () { return ...

  6. List 数据分批入库

    直接贴代码,主要运用 List<E> subList(int fromIndex, int toIndex); 把 List 分割 /** * 保存批价结果 * * @param pric ...

  7. 排序:ORDER BY

    1.按照字段值进行排序: 语法:order by 字段 升序|降序 (asc|desc) 默认情况下为“升序” asc.asc=ascending 升 desc=descending 降 2.允许多字 ...

  8. 关于XShell&XFtp

    今天在开发的时候要打包一个东东到测试服务器去,突然发现xftp用不了,然后各种下载破解.绿色版 结果都是一堆广告,原来这个xshell支持民用版,无需破解就能下载使用,这里小小的记录下 一.  前言 ...

  9. Reverse-Encrypted-Shell-via-Openssl

    目录 0x01 简介 0x02 使用openssl反弹加密shell 0x01 简介 使用常规NC或者其他常规的方法反弹shell,由于流量都是明文的,很容易被网络防御设备检测到,因此需要对传输内容进 ...

  10. Linux下载安装

    博客及下载 https://www.cnblogs.com/nongzihong/p/10475753.html centos镜像 下载 https://blog.csdn.net/sinat_365 ...