倾程记--Ndoc —.net代码文档生成利器

倾程记 flyby 本站首页 管理页面写新日志退出

flyby 发表于 2005/7/14 13:38:51

英文版下载地址：http://ndoc.sourceforge.net 中文版下载地址：http://www.percyboy.com/w/ndoc/default.aspx 用它可以自动生成程序文档，具体不在说明。这里介绍一下要生成高质量的文档，需要注意的问题是，要正确使用C＃编译器提供的文档注释信息。 C# 编译器将代码中的文档注释处理到 XML 文件中。需要在您的站点实现的具体内容是处理 XML 文件以创建文档。在代码构造（如类型和类型成员）上处理标记。编译器将处理任何为有效 XML 的标记。下列标记提供了用户文档中常用的功能： <c><c>text</c>其中：text 希望将其指示为代码的文本。 <para><para>content</para>其中：content 段落文本。 <see> <see cref="member"/>其中：cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 传递给输出 XML 中的元素名。必须将 member 括在双引号 (" ") 中。 <code><code>content</code>其中：content 希望将其标记为代码的文本。 <param><param name='name'>description</param>其中：name 方法参数名。将此名称用单引号括起来 (' ')。 description 参数说明。 <seealso><seealso cref="member"/>其中：cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 传递给输出 XML 中的元素名。必须将 member 括在双引号 ("") 中。 <example><example>description</example>其中：description 代码示例的说明。 <paramref><paramref name="name"/>其中：name 要引用的参数名。将此名称用双引号括起来 (" ")。 <summary><summary>description</summary>其中：description 对象的摘要。 <exception><exception cref="member">description</exception>其中：cref = "member" 对可从当前编译环境中获取的异常的引用。编译器检查到给定异常存在后，将member 转换为输出 XML 中的规范化元素名。必须将 member 括在双引号 (" ") 中。 description 说明。 <permission><permission cref="member">description</permission>其中： cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 转换为输出 XML 中的规范化元素名。必须将 member 括在双引号 (" ") 中。 description 对成员的访问的说明。 <value><value>property-description</value>其中：property-description 属性的说明。 <include><include file='filename' path='tagpath[@name="id"]' />其中： filename 包含文档的文件名。该文件名可用路径加以限定。将 filename 括在单引号中 (' ')。 tagpath filename 中指向标记名的标记路径。将此路径括在单引号中 (' ')。 name 注释前边的标记中的名称说明符；名称具有一个 id。 id 位于注释之前的标记的 ID。将此 ID 括在双引号中 (" ")。 <remarks><remarks>description</remarks>其中：description 成员的说明。 <list><list type="bullet" | "number" | "table"> <listheader> <term>term</term> <description>description</description> </listheader> <item> <term>term</term> <description>description</description> </item></list>其中：term 要定义的项，该项将在 text 中定义。 description 项目符号列表或编号列表中的项或者 term 的定义。 <returns><returns>description</returns>其中：description 返回值的说明。

阅读全文(3748) | 回复(1) | 编辑 | 精华

回复:Ndoc —.net代码文档生成利器

心得体会, 软件技术

flyby发表评论于2005/7/16 11:56:27

真的很不错的工具！

个人主页 | 引用回复 | 主人回复 | 返回 | 编辑 | 删除

» 1 »

发表评论：