GhostDoc:生成.NET API文档的工具 (帮忙文档)

Sandcastle:生成.NET API文档的工具 (帮忙文档) 后提供另一个生成API文档的工具.

 

1) 准备工作

安装GhostDoc Proc. 收费的哦....

这个工具的优势是不像Sandcatle那样在生成XML.

image

选择要生成的项目. 点击生成. 没了.....

 

关于注释

       /// <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>

<example> 的<code > 用相对路径没有成功过.  不知道相对的是哪个目录, 所以都用绝对路径了...

其它好像没什么差别了.

你可能感兴趣的:(.net)