注释规范
1.哪些地方需要注释？
- 类
- 方法
- 重要的变量
2.注释的作用和注意事项
- 说明类、方法和变量的作用和用法。
- 避免过度注释，不要对每一个变量都进行注释，这样会降低代码的可读性。
3.注释
- 单行注释
//声明一个整数
int number;
number = 10;//将10赋值给number
- 多行注释
/*
这是一个多行注释。
这是一个多行注释。
这是一个多行注释。
*/
文档注释（XML注释）规范
用途
- 描述类、方法和属性。
使用方式
使用///开始一个文档注释。
/// <summary>
/// 计算两个数的和
/// </summary>
/// <param name="firstAddend">第一个加数</param>
/// <param name="secondAddend">第二个加数</param>
/// <returns>两数之和</returns>
public int Add(int firstAddend, int secondAddend)
{
return firstAddend + secondAddend；
}
summary标签：用于介绍。param标签：用于介绍参数列表中的参数。return标签：用于介绍返回的内容。
标签摘要
value标签：用于介绍属性中的value。
<value>用户的名称</value>
example+code标签：用于提供一个或多个示例。
<example>
<code>
Console.WriteLine("HelloWorld!");//输出Hello World！
</code>
</example>
exception标签：用于展示方法可能抛出的异常。
<exception cref="ArgumentException">当输入值无效时抛出</exception>