c#的注释规范

Posted 2022-03-11 arthuryao

1     规范目的

1. 一个软件的生命周期中，80%的花费在于维护；
2. 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护；
3. 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码。为了执行规范，每个软件开发人员必须一致遵守编码规范；
4. 使用统一编码规范的主要原因，是使应用程序的结构和编码风格标准化，以便于阅读和理解这段代码；
5. 好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。

2    例子

        

3    方法注释规范

           ///<summary>

           ///说明：<对该方法的说明>

           ///</summary>

          ///<paramname="<参数名称>"><参数说明></param>

          ///<returns>

          ///<对方法返回值的说明，该说明必须明确说明返回的值代表什么含义>

          ///</returns>

 4     类注释规范

          ///<summary>

         ///属性说明

         ///</summary>

5    单行多行注释

         1、单行注释。格式：// 更改用户姓名

         2、多行注释。格式：/* 更改用户姓名... */

6    命名规则

        1. 要采用大小写混合，提高名字的可读性。为区分一个标识符中的多个单词，把标识符中的每个单词的首字母大写。不采用下划线作分隔字符的写法。

　　　　有两种适合的书写方法，适应于不同类型的标识符：

　　　　　1、PasalCasing：标识符的第一个单词的字母大写；

　　　　　2、camelCasing：标识符的第一个单词的字母小写。

         2.  下表描述了不同类型标识符的大小写规则：