编码规范

程序的编码规范

 

变量命名不要使用i，x这种单个字母，除非是在for循环体内部，采用caml命名法，就是单词的首字母大写。所有名称要清晰，尽量可以表达

 

1、 类私有变量：下划线开头，下划线后面小写开头，单词的第一个子母大写，例如：private string _userName;

 

2、 受保护的变量：大写开头，每个单词的第一个字母大写，例如：protected string UserName;

 

3、 类属性：大写开头，每个单词的第一个字母大写，和对应的私有变量保持单词一致，例如：

 

 

 

 public string UserName

 

        {

 

            set { this._userName = value; }

 

            get

 

            {

 

                return this._userName;

 

            }

 

    }

 

 

 

 

 

4、 方法：大写字母开头，每个单词的第一个字母大写，例如：GetMessage（string userName）；

 

private void GetMessage(string userName)

 

{

 

   }

 

5、 方法中的参数：第一个字母小写，每个单词的第一个字母大写，例如：

 

 

 

private void GetMessage(string userName)

 

{

 

   }

 

6、 添加数据的方法以Add开头，删除数据的方法以Delete开头，修改数据的方法以Modify开头，有条件查询数据的方法以Find开头，获取数据的方法以Get开头，例如：AddUser，DeleteUser，ModifyUser，FindUser，GetUser。如果功能是为某一类用户专用，在后面添加ForPlanter，例如：FindOrderForPlanter

 

7、 一个方法不要太长，最好控制在50行以内，否则考虑分出一个方法

 

8、 对于逻辑复杂的方法，添加方法注释

 

9、 对于意思表达不清楚的变量，添加变量注释

 

10、   用常量代替程序中的固定数值

 

11、   合理的使用枚举量enum代替一些字符串比较，状态比较之类的

 

12、   程序中的一些路径之类的最好使用相对路径，不要写死，就算要写死，也用一个常量来管理，好修改，要不然遍布到处不好定位

 

13、常量全部大写

14、错误返回值常量用E_开头.

 

 

• T-SQL的编码规范

 

1.       由四部分组成，第四部分为可选部分：

 

1)      第一部分，所有存储过程以 Proc_ 开头

2)      第二部分，后面是对象名，例如： Proc_PlanterInfo

3)      第三部分，在后面是具体的操作，例如：Proc_PlanterInfo_Get。

4)      第四部分，可选部分，如果存储过程是为某一类用户专用的，最后加上ForPlanter，例如:Proc_Planter_Find_ForPlanter

2.       第三部分的编写规范

1)      查询功能的存储过程使用Find

2)      获取单个数据使用Get，如果获取的条件单一或者很少，例如只有ID，使用GetByID

3)      修改记录使用Modify

4)      添加记录使用Add

5)      删除记录使用Dlelete