版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
软件有限公司呼叫中心项目软件开发代码规范性标准概述目的制定规范,约束开发人员在开发过程中随意性、不规范性,减少开发后期带来的不必要的成本浪费。要求开发人员开发之前,必须通读开发规范中的内容(理解规范中的要求)。在开发过程中,必须严格执行规范中制定的规范内容,如果检查过程中发现没有按规范执行的,按《呼叫中心项目软件开发代码规范性检查办法》执行。规范细则详述注释所有的注释文字一律使用简体中文。类注释在import语句和class声明语句之间必须加类的注释,格式如下:要有功能说明、创建人、创建日期、修改人(如果修改了部分代码)、修改日期、修改说明、版本号。方法注释在方法前必须添加注释。对于设置(Set方法)与获取(Get方法)成员的方法,在成员变量已有说明的情况下,可以不加注释。对于类似stuts的ACTION方法,其输入输出参数固定、格式统一的,参数说明可以省略。属性注释注释格式://注释内容。写明该属性的含义。代码内注释主要变量定义、引用及复杂的算法需注释。代码段落注释,说明以下代码段在该方法中具体实现的功能;注释格式://注释内容或以“/*”开始,“*/”结尾注释。修改注释当创建人与修改人不是同一个的情况下,需加修改注释。在增加的代码前添加注释,内容包括增加部分功能说明、增加人、增加日期、增加部分开始声明。结束部分添加注释,注释内容包括增加部分功能说明、增加人、增加日期、增加部分结束声明。以上包括增加、修改和删除的注释。命名包命名包的名字应该能够说明包的用途,通常应是名词或名词短语。包的名字应该全部由小写字母构成.;如果包的用途必须由两个或多个单词才能描述清楚,可以直接将这些单词连接作为包名.”;如果连接后的包名太长,可以使用单词的缩写(缩写必须不会引起歧义)或取每个单词的首字母。类命名首字母大写;类的名字应该能够说明类的用途,通常应是名词或名词短语。类的名字由若干单词连接而成,每个单词的首字母应大写,其他字母小写;如果某个词是一个缩写形式,则这个词应全部大写.。方法命名所有的方法(构造函数除外)名都应能说明方法的用途,通常取动词或动词短语,也可能是名词或名词短语。方法名由若干单词连接而成,第一个单词应全部小写,其余单词的首字母大写。对于以名词或名词短语命名的方法,建议改成动词或动词短语形式。变量命名通常由1—3个英文单词/简写组成,尽量不能超过4个单词;通常组成形式是:形容词+名词,名词+名词,动词+名词;如:nUserNum,AddUser.jsp每个变量首字母必须小写,每个单词首字母大写(数据库除外);可以添加数字或下划线的组合;避免使用类似的名字如变量名persistentObject与persistentObjects不能同用;绝对禁止包含汉字、拼音、无含义字母、空格和特殊字符;常量命名变量的名字应该都大写,并且指出完整含义。JSP命名Jsp的文件的开头都以小写开头,其他单词第一字母要大写,其余小写。同一个业务建立一个意义相同单词的目录,且相同的jsp都在相同的目录下。SSH命名Package的命名及应用包的最上层规定为com.order.cc在每次增加一个业务功能时,就要增加一个新包,新包下的结构包括:action、form、entity、dao、idao、svc。action:jsp提交时对应的方法入口。form:jsp与后台数据的缓冲。entity:相关数据对象的实体文件。dao:所有的数据库操作都要在此类中完成,禁止数据库sql在其他类中出现。idao:dao的接口类。svc:业务逻辑在此类中实现,与dao挂钩。注:此包在命名可以根据具体的功能来灵活命名,一般业务可以参照此包的结构来实现Class的命名及应用Class的名字必须由大写字母开头并且每个独立的单词第一个字母也必须以大写开头,其他字母都小写的单词组成。Action类名形式:描述性名称+Action.javaForm类名形式:描述性名称+Form.javaEntity类名形式:描述性名称+Entity.javaDao类类名形式:描述性名称+DAO.javaIDao类类名形式:I+描述性名称+DAO.javasvc类类名形式:描述性名称+Serivce.java注:此类的命名是对上面包命名的一个规定,如包不属于上述结构,class完全可以不依照上面的命名在struts-config.xml命名path时,不要带路径,防止路径混乱。正确的命名如下:path="/menuAction"格式缩进规范类中的成分,使用缩进;方法体或语句块中的成分,使用缩进;换行时的非起始行,使用缩进;缩减量一般为在上一级成分的基础上再缩进四个空格。空行规范包语句与import语句间空两行;Import语句与class定义之间空两行;方法与方法之间以空行分隔;函数内部数据与代码之间应空至少一行,代码中适当处应以空行空开,建议在代码中出现变量声明时,在其前空一行;在
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
最新文档
- 2024年南宁客运从业资格证考试题目和答案图片
- 2024年三亚驾驶员客运从业资格证模拟考试题库
- 2024年延安办理客运从业资格证理论考试题
- 2024年从业资格证考客运
- 2024年济南汽车驾驶员客运资格证考试题及答案
- 智能教育机器人行业消费者群体特征分析
- 区块链医疗数据共享行业的消费心理分析
- 育婴员(五级)考试题库及答案
- 艺术品保险行业的消费心理分析
- 低碳汽车行业投资机会分析与策略研究报告
- 服务提升房地产企业核心竞争力新利器范本
- 第四章-环境分析与理性决策-管理学(马工程)共课件
- 三年级道德与法治上册 (我学习 我快乐)快乐学习课件
- 建设工程前期工作咨询费收费计算表
- 股票技术分析看盘操盘课件
- 全球卫生治理课件
- 第八讲 发展全过程人民民主PPT习概论2023优化版教学课件
- 大学生安全教育(综合篇)学习通课后章节答案期末考试题库2023年
- Scratch一阶1-海底世界
- 《义务教育英语课程标准(2022年版)》解读(小学) 2
- 2输变电工程施工质量验收统一表式(变电工程土建专业)
评论
0/150
提交评论