程序员开发手册.docx

文档介绍：《安全生产信息化管理系统》
程序员开发手册
1概述
目的
1、方便代码的交流和维护。
2、不影响编码的效率,不与大众****惯冲突。
3、使代码更美观、阅读更方便。
4、使代码的逻辑更清晰、更易于理解。
范围
本手册适用于开发部全体人员,作用于软件项目开发的代码编写阶段和后期维护阶段。
警示
通过自动检查【】或人工检查【部门主管或相关负责人】不符合编码规范的,必须在限期【部门主管或相关负责人指定时间】内修正,逾期视为工作过失,部门主管或相关负责人视具体情况做出相关处理。
术语定义
1、匈牙利命名法【禁用】
标识符的名字以一个或者多个小写字母开头作为前缀;前缀之后的是首字母大写的一个单词或多个单词组合,该单词要指明变量的用途。
例如:aUserId     数组(Array)定义以小写字母a开头
2、帕斯卡(pascal)命名法【推荐】
将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如:UserId
3、骆驼(Camel)命名法【推荐】
标识符的首字母小写,而每个后面连接的单词的首字母都大写。例如: userId
2代码格式
列宽
1、为了防止在阅读代码时不得不滚动源代码编辑器,每行代码或注释在一般显示频率下不得超过一显示屏,代码列宽控制在110字符左右。
2、系统中部分代码可以不遵循此原则。
如:VIWFormItemDetail[] dv = (VIWFormItemDetail[])(sql, , sqlParams);
3、SQL语句拼接、字符串拼接、函数参数名过长、判断语句过长的代码要遵循以上原则。
换行
1、当表达式超出或即将超出规定的列宽,一行被分为几行时,通过将串联运算符放在每一行的末尾而不是开头,清楚地表示没有后面的行是不完整的。
String querySql = “ SELECT ProjectId”+“,ProjectTitle ”+“FROM Project ”
2、每一行上放置的语句避免超过一条。
3、当表达式超出或即将超出规定的列宽,遵循以下规则进行换行
(1)在逗号前换行。
(2)在操作符前换行。
(3)规则1优先于规则2。
例如:
StringBuilder querySql = new StringBuilder();
("SELECT AS PK ");
(",");
(",");
(", AS ISBNCode");
("FROM Project a ");
当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。
缩进
缩进应该是每行一个Tab(4个空格),不要在代码中使用Tab字符。
Visual 设置:工具->选项->文本编辑器->C#->制表符->插入空格
空行
空行是为了将逻辑上相关联的代码分块,以便提高代码的可阅读性。
在以下情况下使用两个空行
1、接口和类的定义之间。
2、枚举和类的定义之间。
3、类与类的定义之间。
在以下情况下使用一个空行
1、方法与方法、属性与属性之间。
2、方法中变量声明与语句之间。
3、方法与方法之间。
4、方法中不同的逻辑块之间。
5、方法中的返回语句与其他的语句之间。
6、属性与方法、属性与字段、方法与字段之间。
7、注释与它注释的语句间不空行,但与其他的语句间空一行。
空格
在以下情况中要使用到空格
1、关键字和左括符“(”应该用空格隔开。如
while (true)
注意;在方法名和左括符“(”之间不要使用空格,这样有助于辨认代码中的方法调用与关键字。多个参数用逗号隔开,每个逗号后都应加一个空格。
2、除了. 之外,所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作数间不需要空格。如
a+=c+d;
a = (a + b) / (c * d);
while(d++ = s++)
{
n++;
}
PrintSize(“size is “+size+“\n”);
3、语句中的表达式之间用空格隔开。如
for(expr1; expr2; expr