分享 关于c#注释的规范

       C# 提供一种机制，使程序员可以使用含有 XML 文本的特殊注释语法为他们的代码编写文档。在源代码文件中，具有某种格式的注释可用于指导某个工具根据这些注释和它们后面的源代码元素生成 XML。使用这类语法的注释称为文档注释 (documentation comment)。这些注释后面必须紧跟用户定义类型（如类、委托或接口）或者成员（如字段、事件、属性或方法）。XML 生成工具称作文档生成器 (documentation generator)。（此生成器可以但不一定必须是 C# 编译器本身。）由文档生成器产生的输出称为文档文件 (documentation file)。文档文件可作为文档查看器 (documentation viewer) 的输入；文档查看器是用于生成类型信息及其关联文档的某种可视化显示的工具。

     下面是我找到的并认为是比较好的学习资料，内容不多，相信大家在半个小时内就能明白并运用到project的代码中。

       简略版：        http://www.cnblogs.com/cccc/archive/2009/08/19/1549866.html

      比较全面的版本： http://wenku.baidu.com/view/31d06469a45177232f60a2fe.html

      这些资料讲的是如何注释规范并产生一个注释的xml文档，那么如何用VS（2010）生成一个xml的注释文档呢?这个也很方便，只需要在工程文件的属性中，build选项中将XML documentation file选项选上即可。

     但是对于我们来说比较关心如何将xml转换为一个可视话的东西，比如html，chm，pdf，所以下面在提供一个链接http://www.36588.com.cn/digital/article/article_21578_1.html，该链接后面提到了如何将注释xml转化为html的方法。

http://kb.cnblogs.com/a/1509532/，该链接是将xml文件转化到chm的方法。

      这些不难，只要耐心的看一会就能学会。希望对大家有帮助！

 

MicroTeam  Liuhang

我们来自   http://blog.sina.com.cn/u/1848729803