TS-GF-01-JAVA程序编码规范

JAVA程序编码规范

JAVA程序编码规范

编制： 批准： 生效日期：

JAVA程序编码规范

文件修订记录

JAVA程序编码规范

目 录

1 2 3

目的........................................................................................................................ 1 范围........................................................................................................................ 1 规范........................................................................................................................ 1 3.1

命名规范 ........................................................................................................ 1

包名 ........................................................................................................ 1 文件名、类名 ........................................................................................ 2 变量名 .................................................................................................... 3 函数/方法名 .......................................................................................... 4

3.1.1 3.1.2 3.1.3 3.1.4 3.2

注释 ................................................................................................................ 4

总体要求 ................................................................................................ 4 方法及格式 ............................................................................................ 5 类注释 ................................................................................................ 5 函数注释 ............................................................................................ 5 方法内部注释 .................................................................................... 6 全局变量注释 .................................................................................... 6 局部/中间变量注释 .......................................................................... 7 参数注释 ............................................................................................ 7 属性注释 ............................................................................................ 7 常量注释 ............................................................................................ 7

3.2.1 3.2.2 3.2.2.1 3.2.2.2 3.2.2.3 3.2.2.4 3.2.2.5 3.2.2.6 3.2.2.7 3.2.2.8 3.3

排版规范 ........................................................................................................ 7

JAVA程序编码规范

1 目的

本文档的目的是通过制定组织级的java程序编码规范达到以下几点要求：

统一组织软件开发过程的编程规范；

通过编码规范提高软件代码的可读性，使得开发人员快速和彻底的理解新代码，极大的降低了软件的维护成本； 通过对编码过程规范化，为开发人员培养了良好的行为习惯 一些习惯自由程序人员可能对这些规则很不适应，但是在多个开发人员共同写作的情况下，这些规则是必需的。

2 范围

本规范适用于JAVA开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。

3 规范

3.1 命名规范

3.1.1 包名

包的命名规范应当能体现出项目资源良好的目录划分，用于将完成不同功能的类分门别类，放在不同的目录（包）下。包的命名规则如下：

JAVA程序编码规范

将公司域名去掉www后反转作为包名开头。如：http://doc.guandang.net，包名开头就是 com.xxx

按不同功能或子系统将项目划分后确定对应的名称，并以“.”号连接到包名开头后面，如：系统管理子系统（取名system），那么包名就是：com.xxx.system 每个字母都要小写

尽量使用英文单词，使开发人员一目了然 3.1.2 文件名、类名

首字母大写

如果是由多个单词组成，那么每个单词的首字母都要大写，而且中间不要使用任何的连接符

选择有意义的名字，必须保证准确、简洁且容易理解，能快速地传达该类的用途

尽量使用完整单词，避免使用拼音或缩写词（除了大家公认的）

当要区别接口类和实现类的时候，在实现类的后面加上“impl”

如：接口类UserInterface.java 接口实现类UserInterfaceImpl.java

JAVA程序编码规范

3.1.3 变量名

选择有意义的名字，能快速地传达该变量的用途 首字母小写开头，后续每个单词首字母大写

变量命名的基本结构为：数据类型+变量名，使用3个字符前缀来表示数据类型

如：定义一个整形变量intDocumentCount，其中int表明数据类型，后面为表意的英文单词组合，每个单词首字母大写

除非是在循环中，否则一般不要使用单个字母作为变量名，i、j、k等只作为小型循环的循环索引变量

静态变量/常量，采用全部大写的形式来书写，对于采用多

JAVA程序编码规范

词合成的变量采用“_”来连接各单词，如：ROOT_PATH

3.1.4 函数/方法名

选择有意义的名字，能快速地传达该变量的用途 首字母小写开头，后续每个单词首字母大写

函数/方法表示一种行为，它代表一种动作，最好是一个动词或者动词词组，如：searchXxxxxx、deleteXxxxxYyyy 属性方法，以get/set开头，其后跟字段名称，字段名称首字母大写。如：getUserName()

3.2 注释

3.2.1 总体要求

注释是整个开发规范中最为重要的组成部分，必须严格执行 注释形式统一：在整个软件产品，使用具有一致的标点和结构的样式来构造注释

注释要简洁：内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害

注释的一致性：修改代码的同时修改相应的注释，以保证代码与注释的同步

注释的数量：注释占程序代码的比例不得低于20% 必加的注释：典型算法必须有注释、在代码不明晰或不可移植处要加注释、对错误修复和解决方法的代码使用注释、

JAVA程序编码规范

在循环和逻辑分支组成的代码中添加注释

3.2.2 方法及格式

3.2.2.1 类注释

注释采用 /** …… */，在每个类（模块）的头部要有必要的注释信息，中文注释模版：

/**

* 公 司：<公司名称>

* 功能描述：<如功能、主要算法、内部各部分之间的关系、该类与其类的关系等，必要时还要有一些如特别的软硬件要求等说明>

* 创 建 人：<创建人姓名>

* 日 期：<创建日期，格式：yyyy-mm-dd> */

3.2.2.2 函数注释

函数注释采用 /** ……*/，在每个函数或者过程的前面要有必要的注释信息，中文注释模版：

/**

* …… 此处隐藏：3433字，全部文档内容请下载后查看。喜欢就下载吧 ……