编码规范v1.0.doc

编程规范文档编号:编码规范文档信息:公司级别规范文件文档名称:编程规范文档类别:工程过程密  级:内部版本信息::创建人:审核者:批准人:批准日期:保管人:存放位置:文档修订记录版本编号或者更改记录编号*变化简要说明(变更内容和变更范围)-1-15彭毅                                                   *变化状态:A——增加,M——修改,D——删除文档审批信息序号审批人角色审批日期签字备注                              目录1  简介    目的    适用范围    背景描述    文档结构  42  总则  53  命名规范    一般命名规范    特定命名规范  74  文件  95  语句    package和import    类和接口    类型    变量    循环    条件语句    其他  146  方法    方法修饰符    参数规则    返回值    内部实现  167  面向对象高级特性  168  结构和注释    结构    注释  219  检查清单  、形式编码提供一个标准,从而改进代码的可维护性,提高代码质量。:Java编码。、整个组织非常的重要:?软件成本的80%来自于维护?几乎没有一个软件从始至终是有一个人维护的?软件规范可以改进代码的可读性,使得程序员能够很快的、:Java编程所必须遵守的细则和Java代码审查清单。对于每一条细则包含三项内容:规范细则简单描述、例子和制定该细则的目的和相关背景知识。审查清单列出了根据该编程规范进行代码审查时所要检查的内容。2总则1)该规范制定的目标是改进程序的可读性,从而提高程序的可理解性、可维护性,提高代码的质量。从科学的角度来讲,不能期望编码规范涵盖了一种编程语言的方方面面,更多的是具有一种指南、参考的性质,应当允许程序员在编码过程中拥有一定的灵活性。从管理的角度来讲,制定的标准、规范是必须要严格遵守和执行的,不能随意的篡改或者事实上违背组织已经采用的标准和规范。因此,程序员在编码过程中应当完全遵守该规范的所有细则,如果在特定的情况下用某种与该规范细则相冲突的形式更有利于程序的可读性,可以考虑保留这种形式,但必须是在经过正式评审、严格控制的情况下实施的。2)在规范细则描述过程中,必须、应当和可以具有特定的含义。必须是指必须遵守的细则,应当是指规范推荐的细则,无特殊情况时必须遵守,可以是指规范不禁止但不推荐的细则。不可以是指必须按要求的去做,不应当是指规范不禁止这么做,但无特殊情况还是不要这么做。:所有的名称必须用英文书写,不准使用汉语拼音例子:zhengzhi  //Mustmofityto:earnValue背景::第一个单词必须小写、第二个单词第一个字母需大写例子:.::名词,不同单词之间不可以用任何其他符号进行分隔,每个单词的第一个字母必须大写例子:Line  LineData背景::抽象类命名应当遵守类名的要求。应当在类名前面大写字母Abstract,以明确表示是抽象类。例子:AbstractLine背景:从名字上就看出是抽象类,更加易读。:接口名称应当遵守类名的要求。应当在接口名前面加上大写字母I,以明确表示是接口。例子:ILine  ILineData背景:明确定义是接口,更加易读一点。:方法(构造方法除外)名应当用“动词+名词”、大小写混排的方式命名,起始必须字   符小写,方法名称中对象应当是隐含的。在适当条件下,可以没有名词。例子:booleanisSigned();voiddrawLine();(); //ShouldNot:();();    //ShouldNot:runThread();背景::变量必须