《新员工入职课程--Java语言编程规范》由会员分享，可在线阅读，更多相关《新员工入职课程--Java语言编程规范（30页珍藏版）》请在金锄头文库上搜索。
1、 Q/DTM 大唐移动通信设备有限公司企业标准大唐移动通信设备有限公司企业标准 Q/DTM 0059-2011 Java 语言编程规范 2011-06-16 发布 2011-06-16 实施 大唐移动通信设备有限公司 发 布 Q/DTM 0059-2011 I 目 次 前前 言言 . III 1 范围范围 1 2 规范性引用文件规范性引用文件 1 3 定义、符号和缩略语定义、符号和缩略语 1 4 编程规范总则编程规范总则 1 5 命名规则（命名规则（NAMING CONVENTIONS） . 2 6 文件组织（文件组织（FILE ORGANIZATION） 3 6.1 定义文件的结构定义文件的
2、结构 3 6.2 目录结构目录结构 5 6.3 其它其它 5 7 程序板式程序板式 6 7.1 空行空行 6 7.2 代码行代码行 7 7.3 代码行内的空格代码行内的空格 8 7.4 对齐对齐 9 7.5 长行拆分长行拆分 9 7.6 注释注释 10 8 编程规则和建议编程规则和建议 12 8.1 表达式表达式 12 8.2 声明和定义声明和定义 14 8.3 整数数据类型及操作整数数据类型及操作 14 8.4 浮点型浮点型 15 8.5 布尔类型布尔类型 15 8.6 变量变量 15 8.7 类型转换类型转换 16 8.8 常量常量 16 8.9 控制流程控制流程 16 8.10 垃圾收集
3、垃圾收集 18 8.11 错误处理错误处理 18 8.12 断言断言 19 8.13 类类 19 8.14 通用规则和建议通用规则和建议 19 8.15 LOG 打印格式打印格式 19 9 代码文档格式代码文档格式 19 Q/DTM 0059-2011 II 9.1 文档内容的基本要求文档内容的基本要求 19 9.2 属性相关的文档标签属性相关的文档标签 20 9.3 类相关的文档标签类相关的文档标签 20 9.4 函数应该包含的文档标签函数应该包含的文档标签 20 9.5 其它注释标签其它注释标签 21 9.6 包和综包和综述注释述注释 22 9.7 常用注释链接标签常用注释链接标签 22
4、Q/DTM 0059-2011 III 前 言 本标准是根据 GB/T 1.1-2009标准化工作导则 第 1 部分：标准的结构和编写起草制订。 本标准是参考 SUN 公司的 Java 编程规范、文档注释、API 生成规范制定，便于指导 Java 软件 研发人员进行规范代码的编写。 本标准提出单位：大唐移动通信设备有限公司研发部。 本标准批准单位：大唐移动通信设备有限公司质量部。 本标准归口单位：大唐移动通信设备有限公司质量部。 本标准起草单位：大唐移动通信设备有限公司研发部。 本标准于 2009 年 12 月 25 日首次发布，2009 年 12 月 30 日开始实施。 本标准于 2011
5、年 05 月 13 日第 2 次修订，2011 年 06 月 16 日发布，2011 年 06 月 16 日开始实施。 Q/DTM 0059-2011 IV 版本更替和修订记录表 时间 起草或修订 人 评审人 修改内容 2009-12-11 庞然、幸勇、 廖军、段雄文 廖军、 冯学勇、 幸勇、 庞然、 符冠、 王述振、 李毅杰、林艺、张有 文、陈伯勇、杨骥 初稿 2011-5-11 张璇 王凯 2、李诚、于喜 朝、彭强、张新发、 刘江伟、 梁斌、 赵晗、 谢瑞莲、王凯、李毅 杰 增加了第 7 章内容，完善了“编程规则和建 议”的内容，将其设置为一个章节 2011-5-26 张璇 根据评审意见修
6、改 Q/DTM 0059-2011 1 大唐移动通信设备有限公司标准 Java 语言编程规范 1 范围范围 本标准规定了 Java 编程规范的总则、Java 编程规范的规则及代码的文档格式。 本标准适用于所有使用 Java 语言作为开发语言的项目。 2 规范性引用文件规范性引用文件 【1】 Java Coding Standard and Recommendation SUN 【2】 Writing Robust Java Code 【3】 How to Write Doc Comments for the Javadoc Tool SUN 【4】 The Java API Documenta
7、tion Generator SUN 【5】 代码走读指导书 大唐移动代码走读项目 3 定义、符号和缩略语定义、符号和缩略语 JDK：Java Development Kit； Eclipse：著名的跨平台的自由集成开发环境（IDE） ； PMD：一个 Java 源码分析器； Checkstyle：提供了一个帮助 JAVA 开发人员遵守某些编码规范的工具。 4 编程规范总则编程规范总则 为了保持代码风格的一致乃至后续的可维护及可跟踪性,有时候必须减少部分灵活性及增加写注释 的时间来保证。实践证明在代码注释/文档上多投入时间，会在项目维护期得到丰厚的回报。 没有规范的注释或者可读性很差的代码所构
8、建的系统是没有必要运行的。 即使运行了， 项目也会因 维护性差而陷入困境。 我们强调代码注释的重要性，一个好的注释应该包含三项： 1） 这段代码干了什么(WhatWhat） ； 2） 逻辑如何实现（HowHow） ； 3） 业务上为什么这样处理，或者流程为什么这样处理（WhyWhy） 。 在我们写完代码的时候请检查一下自己写的文档注释是不是满足了“What，how，why”的要求。当 然“解释问什么这样处理”是在必要时才添加。 问：如何衡量一个函数代码质量的好坏？ 答：可以让程序阅读者在 30 秒之内能大致了解函数是干什么用的。 问: 如何保证代码的质量 答： 1） 程序员自觉遵守编程规范。
9、2） 定期互查以及自动化工具（包括 Eclipse 提供的及 PMD 或者 checkstyle 等外部自动化检查工 具） 问：如何使用 Eclipse 进行高质量且高效的开发？ 答： 1） Eclipse 提 供 了 丰 富 的 快 捷 键 方 式 （ 比 如 Ctrl+Shift+T, Ctrol+O, Ctrl+Shift+L ， Ctrl+Shift+F） 2） Eclipse 提供了 Code Style 的工具，比如 Code Templates，Formatter，Organize Imports. 有这些功能都可以定制，为了保证代码风格的一致，应该统一使用公司定义的风格。公司已
10、经 Q/DTM 0059-2011 2 提供了一套 Eclipse 标准的开发环境，该开发环境已经内置了一些基本的规则。公司会定期根 据开发人员反馈的规则使用情况来调整和增加规则。 Eclipse 提供了 Editor 的 Content Assist 的功能，同上，公司已经制定一套代码模板，一些常用 的代码将被列入模板。 同时模板会根据实际中总结出的经验不断更新， 所以 Eclipse 这套模板功能能有 效地减少程序员的劳动强度。 5 命名规则（命名规则（naming conventionsnaming conventions） 类别类别 规则规则 样例样例 通用 规则 规则 5.1 - 采
11、用全英文单词、大小写混合命名的方式； - 采用该领域的术语； - 尽量少用单词的缩写形式，如果一定要用，必须选择 通用的缩写方式，并且在本 Java 源代码中坚持使用； - 避免使用相似或仅在大小写上有区别的名字； - 尽量避免太长的命名，一般以少于 15 个字符为宜； - 尽量避免使用下划线。 - 模板变量名如果未使用 List,ArrayList 等明显标示， 统一在变量名后增加s 如 List adjCells 或 List adjCellList 类 规则 5.2 - 第一个单词的首字母必须大写， 其它单词的首字母也要 大写 如：PerfTaskClass 属性 变量 规则 5.3 -
12、 第一个单词全部小写，以后单词的第一个字母大写，其 余小写；对于数组类型的数值类型属性，应该采用单词复 数的方式命名（在最后一个单词加上 s）,对于 Vector、 List、Map、Set 等集合数据类型属性，应该采用单词后 加上类型的方式命名。 如：firstName int scores = 1,2,3 List nameList = new ArrayList() 组件 变量 规则 5.4 - 与属性变量类似， 但是采用将组件类型名作为后缀的命 名方法。 如：cancelJButton 成员 方法 规则 5.5 - 方法名的第一个单词均小写，其它单词的首字母大 写；而且方法名中的第一个
13、单词最好是动词形式； - 获取方法以“get”为前缀； - 设置方法以“set”为前缀； - 判断方法以“is”为前缀； 如：deleteTask(), save() 如：getDN(), setName() isEditable(); Q/DTM 0059-2011 3 - 当方法参数和类成员同名时，在方法参数前增 加a进行区别 如public void(int aCounter) this.counter = aCounter; 构造 方法 规则 5.6 - 构造方法必须具有与类名完全一致的名字， 其大小写也 必须完全一致。 常量 规则 5.7 - 以大写字母和下划线组成， 以下划线作为区
14、分语义各部 分的分割符。 DEFAULT_VALUE 文件 规则 5.8 - 文件名必须与包含有 public 关键字的类名或接口名完 全一致，即大小写也必须完全一致，并且在一个文件中只 能包含有一个 public 关键字的类或接口，文件名的后缀 必须是 java。 接口 规则 5.9 - 接口名的第一个字母必须是大写的“I” ，其它部分与 类的命名规范一样。 - 接口实现类名最后加 Impl 如： public interface IOmtApp 包 规则 5.10 - 包名全部用小写字母命名； - 包与子包之间或包与类之间用“.”加以区别； - 包名以 com.datangmobile 开
15、始 如：com.datangmobile.jbcl 6 文件组织（文件组织（File OrganizationFile Organization） 6.1 定义文件的结构定义文件的结构 规则 6.1.1：所有的 Java（*.java）文件必须遵守如下的样式规则： 1) 版权信息。版权信息必须放在 java 文件的开头，比如： /* * Copyright (c) 2009 Datang Mobile Co.Ltd * All right reserved. */ 其它不需要出现在 javadoc 的信息也可以包含在这里。 Eclipse 中设置文件格式的方法： 菜单拦中选中 Windows
16、Preferences 在弹出框中进行如下的设置： Q/DTM 0059-2011 4 2) package/import。package 行要在 import 行之前，与 import 之间空一行。import 中标准的包 名要在本地的包名之前，而且按照字母顺序排序。每个字母的 import 结束之后下面空一行。 package om.conference.applet; import java.io.*; import java.util.List; import java.util.Observable; import myPackage.a; import myPackage.b; 3) Class 类注释。类注释必须放在所有
