代码开发规范 1.0 版.docxVIP

软件项目质量保证编码规范作为软件开发者，我们可以开发低等级的软件，但不能开发低质量的软件。所以，如何实施质量保证，是我们关注的主要问题之一，而编码规范则是实施质量保证的第一步。编码规范已经成为一个老生常谈的问题，几乎每个项目，每家公司都会定义自己的编码规范。但在真正实施时，却在有意或无意地违背编码规范。程序员，不喜欢改变自己的编程习惯。加之，管理者对质量控制不足，导致编码规范往往形同虚设。有些人会认为：遵守编码规范不能给项目带来利益，也不能让客户看到我们为此付出的努力，其完全是团队自发的行为，没有必要做硬性的要求。还有些人有更好的理由：编码规范会破坏创造性和程序质量。我认为，编码规范，在软件构件以及项目管理中，甚至是个人成长方面，都发挥着重要的作用，好的编码规范是提高我们代码质量的最有效的工具之一。编码规范参考　　我本人不太推荐制定过细的编码规范。制定编码规范是为了增强代码的可读性，毕竟代码的结构才是主要关注问题，所以我的编码规范还是比较简短的。里面只是对可能会破坏编码风格的行为进行约束，而没有细化到“空行”甚至“空格”的级别。　编码规范命名空间公共、通用、底层，或者拥有唯一概念的命名空间，长度越短。公司名称.[.用途]?[.子命名空间]比如： 最核心的 Power.Core ，实体类库 Power.Entity， 消息类库 Power.Message以上三者都具有底层、核心、唯一的特性，因此命名空间可以趋短。具有行业特色的命名空间：公司名称. [.行业]. ?[.子命名空间]比如： Power.PowerPIP.Project, Power.PowerOn.Project代码风格花括号“{}”不允许省略，即使只有一段代码。不允许省略访问修饰符。类型默认是密封的。不允许公开字段。使用括号“()”来强调运算符优先级。命名规范类、方法、变量和接口的命名所有定义信息，都不可省略修饰符(private/public/protect等)使用名词或名词短语。使用Pascal方式。别用缩写。用name, address, salary等代替?nam, addr, sal别使用单个字母的变量象i, n, x?等.?使用?index, temp等 变量分类 全局公开变量，禁用，请用全局属性替代静态常量，全名大写，下划线分割，必有注释。全局内部变量大写字母开头。变量名中不使用下划线。临时变量或参数变量小写字母开头。变量不可定位为公开的，只有属性、方法、事件可以。所有的接口名称前加上前缀“I”。例如：类名及公共变量使用Pascal?大小写形式public class?HelloWorld{ private string DemoString =””; //private修饰符不可省略 public int DemoInt =0; //错误，变量禁止直接对外公开 public int DemoInt2 {get;set;} //正确，属性可以对外公开}接口一律以I开头Public interface IEntity { }方法使用Pascal?大小写形式public class HelloWorld{ void?SayHello(string name) {??... }}参数及临时变量的首字母小写void SayHello(string?name){ int iTmp =0; //我是临时整型变量string sSql =”select…”; //我是临时字符串变量bool blnSelected = false; //我是临时布尔变量}界面元素命名规则界面元素通常都和后台的属性、字段名有关联关系。一般定义规则是“前缀” + 名称，前缀一律小写字母，二至三个字符。控件名中文前缀示例TextBox文本框txttxtUserNameComboBox下拉框cbocboDeptListLabel标题框lablabUserInfoRadio单选框rdordoCompanyListBox列表框lstlstDeptImage图片imgimgChinaFormFormfrmfrmMainTable布局表格tabtabMainDataGrid数据表格dgdgUserList数据库相关规范平台自身表结构以PP_ (PowerPlat)作为前缀平台自带业务表结构以 PB_ (PowerPlat Business)作为前缀数据库使用Guid作为关键字段类型表单关键字统一命名为Id。关联关系表中的字段使用 表名Id例：人员表(PB_Human, 关键字 Id)部门表(PB_Department, 关键字 Id)部门人员关系表( PB_BizAreaHuman, 关键字 Id，外键 ： HumanId