Sandcastle:生成.NET API文档的工具 (帮忙文档)
2013-08-02 17:25
543 查看
(1)准备软件 首先需要我们准备如下软件:
SandCastle, 下载地址: http://sandcastle.codeplex.com/releases/view/47665
(2)准备项目文件 准备好程序的dll文件和注释的xml文件.比如本文实例的两个文件:XmlCommentClassDemo.dll 和 XmlCommentClassDemo.XML
注意如果我们的项目关联多个dll,则需要将相关的项目的dll和注释xml文件都准备好.否则的话在帮助文件中将不能点击相关的类.(如果添加了一个类所在的项目dll和xml文件,则此类在chm文件中可以被点击,点击后跳转到此类的说明页面.)
注释的xml文件生成方法: 点击指定项目, 右键属性. 生成 –> 勾选XML文档文件
(3)打开Sandcastle生成文档.
1) 在右侧Documentation Sources中选择DLL.
2) 点击
生成. OK了.
备注: Project Properties为一些生成设置
生成文档内容说明
example 为 API中examle, 可以由多个组成. 由子标签<code>组成
方法1 - 引用外部文件(可以不在项目中) :
<code lang="cs" source="G:\JsonHelperTest.cs" region="DataTableToJson" title="example1" />
source: 文件地址. 可以用相对, 也可以用绝对. 相对是以Sandcastle新建的项目目录
region: 文件中使用 #region DataTableToJson 的部分做为example的代码
title: 在Api中Example区域显示的标题
方法2 - 直接法, 直接在当前的方法或类注释中的<code>写入example代码
/// <code>
/// AAA.GetJosn(dt)
/// </code>
生成API工具二: GhostDoc
使用教程: /article/6647985.html
部分引用: /article/4677238.html
SandCastle, 下载地址: http://sandcastle.codeplex.com/releases/view/47665
(2)准备项目文件 准备好程序的dll文件和注释的xml文件.比如本文实例的两个文件:XmlCommentClassDemo.dll 和 XmlCommentClassDemo.XML
注意如果我们的项目关联多个dll,则需要将相关的项目的dll和注释xml文件都准备好.否则的话在帮助文件中将不能点击相关的类.(如果添加了一个类所在的项目dll和xml文件,则此类在chm文件中可以被点击,点击后跳转到此类的说明页面.)
注释的xml文件生成方法: 点击指定项目, 右键属性. 生成 –> 勾选XML文档文件
(3)打开Sandcastle生成文档.
1) 在右侧Documentation Sources中选择DLL.
2) 点击
生成. OK了.
备注: Project Properties为一些生成设置
生成文档内容说明
/// <summary>
/// Datatable转换为Json
/// </summary>
/// <param name="table">Datatable对象</param>
/// <returns>Json字符串</returns>
/// <example>
/// <code lang="cs" source="G:\JsonHelperTest.cs" region="DataTableToJson" title="example1" />
/// <code lang="cs" source="G:\JsonHelperTest.cs" region="DataTableToJson" title="example2" />
/// <code>
/// AAA.GetJosn(dt)
/// </code>
/// </example>
summary 为 API中的 Description/// Datatable转换为Json
/// </summary>
/// <param name="table">Datatable对象</param>
/// <returns>Json字符串</returns>
/// <example>
/// <code lang="cs" source="G:\JsonHelperTest.cs" region="DataTableToJson" title="example1" />
/// <code lang="cs" source="G:\JsonHelperTest.cs" region="DataTableToJson" title="example2" />
/// <code>
/// AAA.GetJosn(dt)
/// </code>
/// </example>
example 为 API中examle, 可以由多个组成. 由子标签<code>组成
方法1 - 引用外部文件(可以不在项目中) :
<code lang="cs" source="G:\JsonHelperTest.cs" region="DataTableToJson" title="example1" />
source: 文件地址. 可以用相对, 也可以用绝对. 相对是以Sandcastle新建的项目目录
region: 文件中使用 #region DataTableToJson 的部分做为example的代码
title: 在Api中Example区域显示的标题
方法2 - 直接法, 直接在当前的方法或类注释中的<code>写入example代码
/// <code>
/// AAA.GetJosn(dt)
/// </code>
生成API工具二: GhostDoc
使用教程: /article/6647985.html
部分引用: /article/4677238.html
相关文章推荐
- 一个生成.net api文档的工具sandcastle
- GhostDoc:生成.NET API文档的工具 (帮忙文档)
- Sandcastle - 生成.NET API文档的工具
- Sandcastle 生成.NET API文档的工具
- .NET项目工程生成一份项目帮助文档chm--Sandcastle工具
- 用Sandcastle生成.net项目API文档
- .NET项目工程生成一份项目帮助文档chm--Sandcastle工具
- 使用Sandcastle工具为.NET项目工程生成一份项目帮助文档chm
- .NET项目工程生成一份项目帮助文档chm--Sandcastle工具
- 使用Sandcastle工具为.NET项目工程生成一份项目帮助文档chm
- 告别手写 API文档生成工具推荐
- 告别手写 API文档生成工具推荐
- .net文档生成工具2.0 支持自定义文档生成器【转:http://www.cnblogs.com/lucc/archive/2008/09/05/1284762.html】
- 利用Javadoc工具生成api文档
- Sandcastle----强大的C#文档生成工具
- Javascript API文档生成工具YUIDoc的安装
- android studio中kotlin语言生成API文档工具GenerateDokka
- 推荐开源Api文档生成工具——Doxygen
- 文档API生成神器SandCastle使用心得
- 用Eclipse ANT工具生成JFreeChart的所有API文档