c#注释规范

公司代码整改，特将c#注释规范总结下：

c#注释一般如下：

1：单行注释，用//开始。

//这是一个注释

2：块注释，/**/

/*
注释内容，
可以随意换行
*/

3：XML注释方式（Extensible Markup Language 可扩展标记语言），///开始

        /// <summary>
        ///这是一个加法求和方法
        /// </summary>
        /// <param name="a">第一个数</param>
        /// <param name="b">第二个数</param>
        /// <returns></returns>
        public double Sum(double a,double b)
        {
            return a + b;
        }

一级注释：

1. <remarks> 对类型进行描述，功能类似 < summary>，据说建议使用 < remarks>;
2. <summary> 对共有类型的类、方法、属性或字段进行注释；
3. <value> 主要用于属性的注释，表示属性的制的含义，可以配合 < summary > 使用；
4. <param> 用于对方法的参数进行说明，格式：<param name="param_name">value</param>；
5. <returns> 用于定义方法的返回值，对于一个方法，输入 /// 后，会自动添加 < summary>、<param > 列表和 < returns>；
6. <exception> 定义可能抛出的异常，格式：<exception cref="IDNotFoundException">；
7. <example> 用于给出如何使用某个方法、属性或者字段的使用方法；
8. <permission> 涉及方法的访问许可；
9. <seealso> 用于参考某个其它的东东：)，也可以通过 cref 设置属性；
10. <include> 用于指示外部的 XML 注释；

二级注释：（必须包括在一级注释内）

1. <c> or <code > 主要用于加入代码段；
2. <para> 的作用类似 HTML 中的 < p > 标记符，就是分段；
3. <pararef> 用于引用某个参数；
4. <see> 的作用类似 < seealso>，可以指示其它的方法；
5. <list> 用于生成一个列表；

其中1和2方式是常规注释，3注释会被编译成xml文件。

4：region注释方式

region预处理指令用于给程序段添加逻辑功能注释，让某一部分代码实现的逻辑功能看起来更清晰。
被包围的代码还可以折叠和展开。

            #region 授权调用参考
            int drawing = 1;// 导出图纸参数
            //如果导出图纸参数为1，判定如果没有二三维权限，则将导出图纸参数设为0
            if (drawing == 1 && !authCheck.AuthCheckFunctionalModule(1))
            {
                Console.WriteLine("TokenLisence中无二三维一体化功能权限!");
                drawing = 0;
            }
            
            #endregion

5：参考资料：一篇比较详细的注释规范https://blog.csdn.net/becausehome/article/details/48912817