** 简介 ** ** **
大多数程序员可能都听说过 Java 自带的一个工具 JavaDoc ；使用它可以自动地为你的代码生成 HTML 文档。 C ＃和 C ＃编译器也有类似的功能，不过它生成的是 XML ，而不是直接生成 HTML 。不过使用 XML 会使得文档更加灵活。
** 注释语法 ** ** **
为了使用 C ＃提供的 XML 注释功能，你的注释应该使用特殊的注释语法（ /// ）开头。在 /// 之后，你可以使用预先定义的标签注释你的代码，也可以插入你自己定义的标签。你定制的标签将会在随后加入到生成的注释文档中。
** 预定义的标签 ** ** ** 用处
1<c> 将说明中的文本标记为代码
2
3<code> 提供了一种将多行指示为代码的方法
4
5<example> 指定使用方法或其他库成员的示例
6
7<exception> 允许你指定可能发生的异常类
8
9<include> 允许你引用描述源代码中类型和成员的另一文件中的注释 , 使用 XML XPath 语法来描述你的源代码中的类型和成员。
10
11<list> 向 XML 注释文档中插入一个列表
12
13<para> 向 XML 注释文档中插入一个段落
14
15<param/> 描述一个参数
16
17<paramref> 提供了一种指示一个词为参数的方法
18
19<permission> 允许你将成员的访问许可加入到文档中
20
21<remarks> 用于添加有关某个类型的信息
22
23<returns> 描述返回值
24
25<see> 指定链接
26
27<seealso> 指定希望在 “ 请参见 ” 一节中出现的文本
28
29<summary> 类型或类型成员的通用描述
30
31<value> 描述属性
32
33---
34
35** 例子 ** ** **
36
37下面的例子为我们常见的 HelloWorld 控制台应用程序添加注释：
38
39using System;
40
41namespace HelloWorld
42{
43/// <summary>
44/// Sample Hello World in C#
45/// </summary>
46public class HelloWorld
47{
48/// <summary>
49/// Console Application Entry Point
50/// <param name="args"/>Command Line Arguments
51/// <returns>Status code of 0 on successful run</returns>
52/// </summary>
53public static int Main(string[] args)
54{
55System.Console.WriteLine("HelloWorld");
56string name = System.Console.ReadLine();
57
58return(0);
59}
60}
61}
62
63---
64
65为生成 XML 注释文档，我们在调用 csc 编译源代码时使用 /doc 选项：
66
67csc /doc:HelloWorld.xml helloworld.cs
68
69---
70
71生成的结果文档如下：
72
73<?xml version="1.0"?>
74<doc>
75<assembly>
76<name>XMlComment</name>
77</assembly>
78<members>
79<member name="T:HelloWorld.HelloWorld">
80<summary>
81
82Sample Hello World in C#
83
84</summary>
85</member>
86<member name="M:HelloWorld.HelloWorld.Main(System.String[])">
87<summary>
88
89Console Application Entry Point
90
91<param name="args"/>Command Line Arguments
92
93<returns>Status code of 0 on successful run</returns>
94</summary>
95</member>
96</members>
97</doc>
98
99---
100
101** HTML ** ** 页面 ** ** **
102
103你可能会问自己：我应该如何才能得到具有良好格式的 HTML 页面呢？很简单，你可以编写自己的 XSL 来转换生成的 XML 注释文档，或者使用 Visual Studio.NET 开发工具。通过使用 VS.NET 的【工具】菜单中的【生成注释 web 页】，你可以得到一系列详细说明你的项目或解决方案的 HTML 页面。下面就是通过 VS.NET 生成的注释 helloWorld 程序的 HTML 页面快照：
104
105</value></summary></seealso></see></returns></remarks></permission></paramref></para></list></include></exception></example></code></c>