程序员开发手册.pdfVIP

. 《安全生产信息化管理系统》 程序员开发手册 1 概述 1.1 目的 1 、方便代码的交流和维护。 2 、不影响编码的效率，不与大众习惯冲突。 3 、使代码更美观、阅读更方便。 4 、使代码的逻辑更清晰、更易于理解。 1.2 范围 本手册适用于开发部全体人员， 作用于软件项目开发的代码编写阶段和后期 维护阶段。 1.3 警示 通过自动检查 【Microsoft.StyleCop 】或人工检查 【部门主管或相关负责人】 不符合编码规范的，必须在限期【部门主管或相关负责人指定时间】内修正 , 逾 期视为工作过失，部门主管或相关负责人视具体情况做出相关处理。 1.4 术语定义 1、匈牙利命名法【禁用】 标识符的名字以一个或者多个小写字母开头作为前缀； 前缀之后的是首字母大 写的一个单词或多个单词组合，该单词要指明变量的用途。 例如： aUserId 数组 (Array) 定义以小写字母 a 开头 2、帕斯卡（ pascal ）命名法【推荐】 将标识符的首字母和后面连接的每个单词的首字母都大写。 可以对三字符或更多 字符的标识符使用 Pascal 大小写。例如： UserId 3、骆驼 (Camel) 命名法【推荐】 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如： userId word 编辑文档 . 2 代码格式 2.1 列宽 1、为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在一 般显示频率下不得超过一显示屏，代码列宽控制在 110 字符左右。 2、系统中部分代码可以不遵循此原则。 如：VIWFormItemDetail[] dv = (VIWFormItemDetail[])MHelper.SQLCommand.query(sql, VIWFormItemDetail.TName, sqlParams); 3、SQL语句拼接、字符串拼接、函数参数名过长、判断语句过长的代码要遵 循以上原则。 2.2 换行 1、当表达式超出或即将超出规定的列宽，一行被分为几行时，通过将串联 运算符放在每一行的末尾而不是开头，清楚地表示没有后面的行是不完整的。 String querySql = “ SELECT ProjectId ”+ “,ProjectTitle ”+ “FROM Project ” 2、每一行上放置的语句避免超过一条。 3、当表达式超出或即将超出规定的列宽，遵循以下规则进行换行 (1) 在逗号前换行。 （2）在操作符前换行。 （3 ）规则 1 优先于规则 2 。 例如： StringBuilder querySql = new StringBuilder(); querySql.Append(SELECT a.ProjectId AS PK ); querySql.Append(,a.ProjectTitle); querySql.Append(,a.ProjectDisplayCode); querySql.Append(,a.IsbnCode AS ISBNCode); querySql.Append(FROM Project a ); 当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。 word 编辑文档