软件有限公司呼叫中心项目软件开发代码规范性标准.docx

软件有限公司呼叫中心项目软件开发代码规范性标准1概述1.1目的 制定规范，约束开发人员在开发过程中随意性、不 规范性，减少开发后期带来的不必要的成本浪费。1.2要求 开发人员开发之前,必须通读开发规范中的内容（理 解规范中的要求）。 在开发过程中，必须严格执行规范中制定的规范内 容，如果检查过程中发现没有按规范执行的，按呼叫中心 项目软件开发代码规范性检查办法执行。2规范细则详述2.1注释所有的注释文字一律使用简体中文。类注释在import语句和class声明语句之间必须加类的注释,格式如下：要有功能说明、创建人、创建日期、修改人（如 果修改了部分代码）、修改日期、修改说明、版本号。方法注释1）在方法前必须添加注释。2）对于设置（Set方法）与获取（Get方法）成员的方法， 在成员变量已有说明的情况下，可以不加注释。3）对于类似stuts的ACTION方法，其输入输出参数固 定、格式统一的，参数说明可以省略。属性注释1）注释格式：注释内容。写明该属性的含义。代码内注释1）主要变量定义、引用及复杂的算法需注释。2）代码段落注释，说明以下代码段在该方法中具体实 现的功能；3）注释格式：/注释内容或以“/*”开始，*/”结尾 注释。修改注释当创建人与修改人不是同一个的情况下，需加修改注释O1）在增加的代码前添加注释，内容包括增加部分功能 说明、增加人、增加日期、增加部分开始声明。2）结束部分添加注释，注释内容包括增加部分功能说 明、增加人、增加日期、增加部分结束声明。3）以上包括增加、修改和删除的注释。2.2命名2. 2.1包命名1）包的名字应该能够说明包的用途，通常应是名词或 名词短语。包的名字应该全部由小写字母构成.；2）如果包的用途必须由两个或多个单词才能描述清楚, 可以直接将这些单词连接作为包名.”；3）如果连接后的包名太长，可以使用单词的缩写（缩 写必须不会引起歧义）或取每个单词的首字母。2. 2.2类命名1）首字母大写；2）类的名字应该能够说明类的用途，通常应是名词或 名词短语。类的名字由若干单词连接而成，每个单词的首字 母应大写，其他字母小写；3）如果某个词是一个缩写形式，则这个词应全部大写2. 2.3方法命名1）所有的方法（构造函数除外）名都应能说明方法的 用途，通常取动词或动词短语，也可能是名词或名词短语。 方法名由若干单词连接而成，第一个单词应全部小写，其余 单词的首字母大写。2）对于以名词或名词短语命名的方法，建议改成动词 或动词短语形式。2. 2.4变量命名1）通常由13个英文单词/简写组成，尽量不能超过 4个单词；2）通常组成形式是：形容词+名词，名词+名词，动词+ 名词；如：nUserNum, AddUser. jsp3）每个变量首字母必须小写,每个单词首字母大写（数 据库除外）；4）可以添加数字或下划线的组合；5）避免使用类似的名字如变量名persistentObject 与 persistentObjects 不能同用；6）绝对禁止包含汉字、拼音、无含义字母、空格和特 殊字符；2. 2.5常量命名1) 变量的名字应该都大写，并且指出完整含义。2. 2.6 JSP 命名4) Jsp的文件的开头都以小写开头，其他单词第一字 母要大写，其余小写。5) 同一个业务建立一个意义相同单词的目录，且相同 的jsp都在相同的目录下。2. 2.7 SSH 命名2. 2. 7. 1 Package的命名及应用包的最上层规定为com. order, cc1) 在每次增加一个业务功能时，就要增加一个新包， 新包下的结构包括：action、form、entity、dao idaoSVCo2) action： jsp提交时对应的方法入口。3) form： jsp与后台数据的缓冲。4) entity：相关数据对象的实体文件。5) dao：所有的数据库操作都要在此类中完成，禁止数 据库sql在其他类中出现。6) idao： dao 的接口类。7) svc：业务逻辑在此类中实现，与dao挂钩。注此包在命名可以根据具体的功能来灵活命名，一般 业务可以参照此包的结构来实现2. 2. 7. 2 Class的命名及应用1) Class的名字必须由大写字母开头并且每个独立的 单词第一个字母也必须以大写开头，其他字母都小写的单词 组成。2) Action类名形式：描述性名称+Action. java3) Form类名形式：描述性名称+Form. java4) Entity类名形式：描述性名称+Entity. java5) Dao类类名形式：描述性名称+DAO. java6) IDao类类名形式：1+描述性名称+DAO. java7) svc类类名形式：描述性名称+Serivce. java注.此类的命名是对上面包命名的一个规定，如包不属 于上述结构，class完全可以不依照上面的命名在struts-config. xml命名path时，不要带路径，防 止路径混乱。正确的命名如下：path=/menuAction”2.3格式2. 3.1缩进规范1）类中的成分，使用缩进；2）方法体或语句块中的成分，使用缩进；3）换行时的非起始行，使用缩进；4）缩减量一般为在上一级成分的基础上再缩进四个空 格。2. 3.2空行规范1）包语句与import语句间空两行；2）Import语句与class定义之间空两行；3）方法与方法之间以空行分隔；4）函数内部数据与代码之间应空至少一行，代码中适 当处应以空行空开，建议在代码中出现变量声明时，在其前 空一行；5）在方法内部代码的逻辑段落小节之间，建议使用空 行。2. 3.3类行数1）每个类需小于1000行；2. 3.4函数行数1）每个函数行小于70行；2. 3.5单行长度1）单行长度不超过125个字符;2. 3.6 1占语块行数1）if语块间不能超过30行；2）其他while语句等类似。