Java编码规范Java编码规范.doc

北京勤实信息技术有限公司 Java编码规范 版权所有：北京勤实信息技术有限公司 trustfar 第 PAGE 3 页 共 NUMPAGES 26 页 北京勤实信息技术有限公司 Java编码规范 密级： FORMCHECKBOX 公开使用 FORMCHECKBOX 内部使用 FORMCHECKBOX 公司秘密 FORMCHECKBOX 公司机密 受控状态：受控文件 文件标识：Java编码规范 Java编码规范 北京勤实信息技术有限公司  版本修改记录 版本号 版本修改说明 作者/日期 审批人/日期 生效日期 V0.1 C：创建 张东2019.6.1 李涛2019.6.1 2019.6.1 说明： C：Create，初始创建；A：Add，增加内容；M：Mod，修改；D：Del，删除  目录 TOC \o 1-2 \h \z \u 1.1 目的 4 1.2 适用范围 4 1.3 背景描述 4 1.4 文档结构 4 2 总则 5 3 命名规范 6 3.1 一般命名规范 6 3.2 特定命名规范 7 4 文件 9 5 语句 11 5.1 package和import 11 5.2 类和接口 12 5.3 类型 12 5.4 变量 12 5.5 循环 13 5.6 条件语句 14 5.7 其他 15 6 方法 15 6.1 方法修饰符 15 6.2 参数规则 16 6.3 返回值 16 6.4 内部实现 17 7 面向对象高级特性 17 8 结构和注释 21 8.1 结构 21 8.2 注释 23 9 检查清单 25 简介 目的 本文制定的目的是为开发组所有程序员按统一风格、形式编码提供一个标准，从而改进代码的可维护性，提高代码质量。 适用范围 本文档的适用范围为：Java编码。 背景描述 编码规范对于程序员、整个组织非常的重要： 软件成本的80%来自于维护 几乎没有一个软件从始至终是有一个人维护的 软件规范可以改进代码的可读性，使得程序员能够很快的、彻底的理解新的代码 文档结构 该文挡主要分为两部分：Java编程所必须遵守的细则和Java代码审查清单。对于每一条细则包含三项内容：规范细则简单描述、例子和制定该细则的目的和相关背景知识。 审查清单列出了根据该编程规范进行代码审查时所要检查的内容。 总则 该规范制定的目标是改进程序的可读性，从而提高程序的可理解性、可维护性，提高代码的质量。从科学的角度来讲，不能期望编码规范涵盖了一种编程语言的方方面面，更多的是具有一种指南、参考的性质，应当允许程序员在编码过程中拥有一定的灵活性。从管理的角度来讲，制定的标准、规范是必须要严格遵守和执行的，不能随意的篡改或者事实上违背组织已经采用的标准和规范。因此，程序员在编码过程中应当完全遵守该规范的所有细则，如果在特定的情况下用某种与该规范细则相冲突的形式更有利于程序的可读性，可以考虑保留这种形式，但必须是在经过正式评审、严格控制的情况下实施的。 在规范细则描述过程中，必须、应当和可以具有特定的含义。必须是指必须遵守的细则，应当是指规范推荐的细则，无特殊情况时必须遵守，可以是指规范不禁止但不推荐的细则。不可以是指必须按要求的去做，不应当是指规范不禁止这么做，但无特殊情况还是不要这么做。 命名规范 一般命名规范 名称 要求：所有的名称必须用英文书写，不准使用汉语拼音 例子：zhengzhi //Must mofity to:earnValue 背景：英语是国际化语言 包名 要求：必须小写 例子：ac.cn.iscas.intec.entity.pm 背景：包名相当于类的命名空间 类名 要求：名词，不同单词之间不可以用任何其他符号进行分隔，每个单词的第一个字母必须大写 例子：Line LineData 背景：Java开发的共同约定和Sun核心包的类型命名规范 抽象类 要求：抽象类命名应当遵守类名的要求。应当在类名前面大写字母Abstract，以明确表示是抽象类。 例子：AbstractLine 背景：从名字上就看出是抽象类，更加易读。 接口 要求：接口名称应当遵守类名的要求。应当在接口名前面加上大写字母I，以明确表示是接口。 例子：ILine ILineData 背景：明确定义是接口，更加易读一点。 方法名称 要求：方法（构造方法除外）名应当用“动词+名词”、大小写混排的方式