C#注释的一些使用方法浅谈

C# Coding的时候,常常涉及代码注释,常见的注释包括两类:
1)单行注释。格式:// Comments
2)多行注释。格式:/* Comments... */
C#引入了新的XML注释,即我们在某个函数前新起一行,输入///,VS.Net会自动增加XML格式的注释,这里整理一下可用的XML注释。
XML注释分为一级注释(Primary Tags)和二级注释(Secondary Tags),前者可以单独存在,后者必须包含在一级注释内部。
I 一级注释
1. 对类型进行描述,功能类似,据说建议使用;
2. 对共有类型的类、方法、属性或字段进行注释;
3. 主要用于属性的注释,表示属性的制的含义,可以配合使用;
4. 用于对方法的参数进行说明,格式:value;
5. 用于定义方法的返回值,对于一个方法,输入///后,会自动添加列表和
6. 定义可能抛出的异常,格式:
7. 用于给出如何使用某个方法、属性或者字段的使用方法;
8. 涉及方法的访问许可;
9. 用于参考某个其它的东东:),也可以通过cref设置属性;
10. 用于指示外部的XML注释;
II 二级注释
1. or 主要用于加入代码段;
2. 的作用类似HTML中的

标记符,就是分段;
3. 用于引用某个参数;
4. 的作用类似,可以指示其它的方法;
5. 用于生成一个列表;
另外,还可以自定义XML标签

你可能感兴趣的:(C#注释的一些使用方法浅谈)