资 源 简 介
在 dotnet 代码中,可以为代码创建文档。Microsoft 为此提供了一些建议的文档注释标记。这些文档注释可以被 NDoc 等文档注释编译工具编译为 chm 等多种格式的联机帮助文档。
为所有的公共方法添加文档注释说明,是一个良好的编码习惯,但是使用 XML 标记来书写文档注释说明则显得比较麻烦,切不那么直观。相比而言,我更喜欢使用类似 Wiki 的智能标记语法,这使得我们能够更容易书写注释,特别对于大段的,包括章节、列表、表格等复杂内容的注释,使用 Wiki 语法显然比插入一个个 XML 标记要更快捷,也不那么容易出错。
这个小工具就是出于这样一个目的而诞生的。现在你可以使用 Wiki 的语法来书写文档注释,然后使用 wikidoc 对编译生成的 XML 文档文件进行处理,将其中的 Wiki 语法转换为标准的 Html 标记,这样处理后的 XML 文档就能输出到 NDoc 等工具中进一步处理编译为联机帮助。
更多主题
Wiki标记说明
如何参与开发
在生成后事件中使用
命令行参数说明
使用CR\_Documentor预览效果