C# 编程规范 第一章 概述

第一章　概述

 

规范制定原则

 1 方便代码的交流和维护。

   2 不影响编码的效率，不与大众习惯冲突。

   3 使代码更美观、阅读更方便。

   4 使代码的逻辑更清晰、更易于理解。

 

术语定义

Pascal 大小写

      将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如：

               BackColor

Camel 大小写

标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：

                backColor

 

文件命名组织

1.3.1文件命名

1 文件名遵从Pascal命名法，无特殊情况，扩展名小写。

2 使用统一而又通用的文件扩展名： C# 类  .cs

1.3.2文件注释

  1 在每个文件头必须包含以下注释说明

            /*----------------------------------------------------------------

            // 版权所有。

            //

            // 文件名：

            // 文件功能描述：

            //

            //

            // 创建标识：

            //

            // 修改标识：

            // 修改描述：

            //

            // 修改标识：

            // 修改描述：

//----------------------------------------------------------------*/

 

文件功能描述只需简述，具体详情在类的注释中描述。

创建标识和修改标识由创建或修改人员的拼音或英文名加日期组成。如：

 

    李轶20040408

 

一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。

在所有的代码修改处加上修改标识的注释。