程序编写规范

时间:2021-03-08 20:09:00

一、命名规范

1、说明:表达清晰
2Pascal风格:包含一到多个单词,每一个单词第一个字母大写,其余字母小写。例如:HelloWorldSetName等。
3Camel风格:包含一到多个单词,第一个单词首字母小写,其余单词首字母大写。例如:name、productld等

二、标识符的大小写规则

1、除了参数与变量外,所有命名空间名称、类、函数、接口、属性等名称的命名,使用Pascal风格。
2、参数与变量的命名使用Camel风格。

三、通用命名约定

1、选择名称,选择易读的英文名称,例如,Order的意思是,次序、规则。订购等。
2、除了下划线外,不要使用连字符或任何其他非字母数字字符。比如产品分类表ProductClass中有字段Id与Name,那么产品表绑定的这两个字段可命名为ProductClass_Id与ProductClass_Name,这样可以清晰的知道这两个字段与分类表的关系。
3、避免使用与常用关键字冲突的标识符
4、变量和方法参数使用Camel风格。
例如:
string productName="";
int number=0;
5、不要使用成员属性作为成员变量的前缀(其他命名也一样)。例如不要像Users m_users;这样定义成员变量。

四、代码编写规范
1、缩进和间隔。缩进用【tab】键,不用【spaces】键。
2、注释和代码对齐。多实用#regedit和#endregion代码块。
3、在代码中垂直对齐左括号和右括号。
4、适当增加空格来增加代码可读性。