版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
XML文档
C#可以根据特定的注释自动创建XML格式的文档说明。
这些注释都是单行注释,但都以三条斜杠开头
编译器识别的标记
标记 | 说明 |
---|---|
<C> |
把行中的文本标记为代码,例如<c> int i=10;</c> |
<code> |
把多行标记为代码 |
<example> |
标记为代码示例 |
<exception> |
说明一个异常类 |
<include> |
包含其他文档说明文件的注释 |
<list> |
把列表插入文档中 |
<para> |
建立文本的结构 |
<param> |
标记方法的参数 |
<paramref> |
表明一个单词是方法的参数 |
<permission> |
说明对成员的访问 |
<remarks> |
给成员添加描述 |
<returns> |
说明方法的返回值 |
<see> |
提供对另一参数的交叉引用 |
<seealso> |
提供描述中的参见部分 |
<summary> |
提供类型或成员的简短描述 |
<typeparam> |
用在泛型类型的注释中,以说明一个类型参数 |
<typepararef> |
类型参数的名称 |
<value> |
描述属性 |
添加XLM注释的方法
在要注释内容的上一行点击三次“/”(要在英文输入的模式下)编译器会自动添加注释内容,如果还是添加不上,在vs下点击工具->选项->文本编辑器->C#->高级->(勾选)为///生成XLM文档注释
/// <summary>
/// 这里添加函数说明描述
/// </summary>
/// <param name="a">这里添加参数说明描述</param>
/// <param name="b">这里添加参数说明描述</param>
/// <returns>这里添加返回值说明描述</returns>
添加XLM注释的例子
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace XML文档
{
class Program
{
static void Main(string[] args)
{
int A = 1;
int B = 2;
Add(A, B);
}
/// <summary>
/// 计算两个整数的和
/// </summary>
/// <param name="a"></param>
/// <param name="b"></param>
/// <returns>返回a,b的和</returns>
static int Add(int a, int b)
{
a = a + b;
return a;
}
}
}