浅析C#文档自动化实现

C#文档自动化了解之前我们先来了解什么是C#文档自动化，熟悉java的程序员都知道，在java中有一种“文档注释”。采用这种注释之后，使用相应的命令，我们就可以得到与代码相关的文档说明。如今，在.net的世界中C#也提供了相同的功能。如果结合相应的工具，它还可以为我们产生漂亮的WEB风格的文档。

C#文档自动化初步认识：

在C#中文档注释对应的符号是：///。但光使用它还是不能为我们产生代码文档，还必须使用特殊的标记才行。这些标记实际上是XML标记，最常用的是< summary >。例如：

/// <summary>  


 



/// A method with a string array param.  



 



/// </summary>  



 



public void Koo(string[] ss) {}  

C#文档自动化的特点：

但是，并不是所有使用文档注释和这些标记的地方编译器都会为我们生成文档，它还会看这些标记是否与一些代码结构相关联。例如：

/// <summary>  


 



/// 不产生这行  



 



/// </summary>  

就不产生任何文档。这些代码结构必须是：class, struct, enum, method, property, field, indexer, delegate, 或event.

C#文档自动化之产生文档的命令

◆命令行：csc /doc: ….xml …..cs；

◆如使用VS.net，则：项目 -> 属性 -> 配置属性 -> 生成 -> 输出 -> xml文档文件(在此填写文件名和路径)；