C#中怎么实现自动化文档

这篇文章将为大家详细讲解有关C#中怎么实现自动化文档，文章内容质量较高，因此小编分享给大家做个参考，希望大家阅读完这篇文章后对相关知识有一定的了解。

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文档文件(在此填写文件名和路径)；

◆如要生成web注释：工具 ->生成注释 web......。

关于C#中怎么实现自动化文档就分享到这里了，希望以上内容可以对大家有一定的帮助，可以学到更多知识。如果觉得文章不错，可以把它分享出去让更多的人看到。