在C＃使用XML注释 选择自 lotusswan 的 Blog
2024-09-05 20:55:46
供稿：网友
菜鸟学堂：
在c＃使用xml注释
简介
大多数程序员可能都听说过java自带的一个工具javadoc；使用它可以自动地为你的代码生成html文档。c＃和c＃编译器也有类似的功能，不过它生成的是xml，而不是直接生成html。不过使用xml会使得文档更加灵活。
注释语法
为了使用c＃提供的xml注释功能，你的注释应该使用特殊的注释语法（///）开头。在///之后，你可以使用预先定义的标签注释你的代码，也可以插入你自己定义的标签。你定制的标签将会在随后加入到生成的注释文档中。
预定义的标签 用处
<c> 将说明中的文本标记为代码
<code> 提供了一种将多行指示为代码的方法
<example> 指定使用方法或其他库成员的示例
<exception> 允许你指定可能发生的异常类
<include> 允许你引用描述源代码中类型和成员的另一文件中的注释, 使用 xml xpath 语法来描述你的源代码中的类型和成员。
<list> 向xml注释文档中插入一个列表
<para> 向xml注释文档中插入一个段落
<param> 描述一个参数
<paramref> 提供了一种指示一个词为参数的方法
<permission> 允许你将成员的访问许可加入到文档中
<remarks> 用于添加有关某个类型的信息
<returns> 描述返回值
<see> 指定链接
<seealso> 指定希望在“请参见”一节中出现的文本
<summary> 类型或类型成员的通用描述
<value> 描述属性
例子
下面的例子为我们常见的helloworld控制台应用程序添加注释：
using system;
namespace helloworld
{
/// <summary>
/// sample hello world in c#
/// </summary>
public class helloworld
{
/// <summary>
/// console application entry point
/// <param name="args">command line arguments</param>
/// <returns>status code of 0 on successful run</returns>
/// </summary>
public static int main(string[] args)
{
system.console.writeline("helloworld");
string name = system.console.readline();
return(0);
}
}
}
为生成xml注释文档，我们在调用csc编译源代码时使用/doc选项：
csc /doc:helloworld.xml helloworld.cs
生成的结果文档如下：
<?xml version="1.0"?>
<doc>
<assembly>
<name>xmlcomment</name>
</assembly>
<members>
<member name="t:helloworld.helloworld">
<summary>
sample hello world in c#
</summary>
</member>
<member name="m:helloworld.helloworld.main(system.string[])">
<summary>
console application entry point
<param name="args">command line arguments</param>
<returns>status code of 0 on successful run</returns>
</summary>
</member>
</members>
</doc>
html页面
你可能会问自己：我应该如何才能得到具有良好格式的html页面呢？很简单，你可以编写自己的xsl来转换生成的xml注释文档，或者使用visual studio.net开发工具。通过使用vs.net的【工具】菜单中的【生成注释web页】，你可以得到一系列详细说明你的项目或解决方案的html页面。下面就是通过vs.net生成的注释helloworld程序的html页面快照：
