java编码规范

更新时间：2023-11-29 23:33:01 阅读量：教育文库文档下载

说明：文章内容仅供预览，部分内容可能不全。下载后的文档，内容与下面显示的完全一致。下载之前请确认下面内容是否您想要的，是否完整无缺。

Document number 文档编号 Document version 文档版本 Confidentiality level 密级 Total 30 pages 共 30 页 Prepared by

拟制

Reviewed by 评审人 Approved by

批准

V1.00

Java语言编码规范

Date 日期 Date 日期

Date 日期

yyyy-mm-dd yyyy-mm-dd yyyy-mm-dd

Java编码规范

Revision Record 修订记录

Date 日期 yyyy-mm-dd Revision Version 修订版本 Vx.xx Sec No. 修改章节 Change Description 修改描述 Author 作者 Copyright ? Worksoft Creative Software Technology NanJing Branch , Ltd. Page 2, Total 30

Java编码规范

Table of Contents 目录

1. 2. 3. 4. 4.1. 4.2. 5. 5.1. 5.2. 6. 6.1. 6.2. 7. 7.1. 7.2. 8. 8.1. 8.2.

范围 ....................................................................................................................................... 4 规范性引用文件 ..................................................................................................................... 4 术语和定义 ............................................................................................................................ 4 排版规范................................................................................................................................ 5 规则 ....................................................................................................................................... 5 建议 ....................................................................................................................................... 7 注释规范................................................................................................................................ 9 规则 ....................................................................................................................................... 9 建议 ..................................................................................................................................... 14 命名规范.............................................................................................................................. 17 规则 ..................................................................................................................................... 17 建议 ..................................................................................................................................... 18 编码规范.............................................................................................................................. 20 规则 ..................................................................................................................................... 20 建议 ..................................................................................................................................... 24 JTEST规范 .......................................................................................................................... 26 规则 ..................................................................................................................................... 26 建议 ..................................................................................................................................... 27

1. 范围

Java编码规范

本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。本规范适用于使用Java语言编程的产品和项目。

2. 规范性引用文件

下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本规范，然而，鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本规范。序号 1 编号公司- DKBA1040-2001.12 名称《Java语言编程规范》 3. 术语和定义

规则：编程时强制必须遵守的原则。建议：编程时必须加以考虑的原则。格式：对此规范格式的说明。

说明：对此规范或建议进行必要的解释。

示例：对此规范或建议从正、反两个方面给出例子。

4. 排版规范 4.1. 规则

Java编码规范

4.1.1. *程序块要采用缩进风格编写，缩进的空格数为4个。

说明：对于由开发工具自动生成的代码可以有不一致。

4.1.2. *分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语

句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

示例：如下例子不符合规范。

for (...) {

... // program code }

if (...) {

... // program code }

void example_fun( void ) {

... // program code }

应如下书写：

for (...) {

... // program code }

if (...) {

... // program code }

void example_fun( void ) {

... // program code }

4.1.3. *较长的语句、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作

符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。

示例：

if (filename != null

&& new File(logPath + filename).length() < LogConfig.getFileSize()) {

... // program code }

public static LogIterator read(String logType, Date startTime, Date endTime, int logLevel, String userName, int bufferNum)

Java编码规范

5.1.6. 类和接口的注释：该注释放在 package 关键字之后，class 或者 interface 关键字之前。

说明：方便JavaDoc收集。示例：

package com.huawei.msg.relay.comm; /**

* 注释内容 */

public class CommManager

5.1.7. 类和接口的注释内容：类的注释主要是一句话功能简述、功能详细描述。

说明：可根据需要列出：版本号、生成日期、作者、内容、功能、与其它类的关系等。如果一个类存在Bug，请如实说明这些Bug。

格式： /**

* 〈一句话功能简述〉 * 〈功能详细描述〉 * @author [作者]

* @version [版本号, YYYY-MM-DD] * @see [相关类/方法] * @since [产品/模块版本] * @deprecated */

说明：描述部分说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期，@since 表示从那个版本开始就有这个类或者接口，@deprecated 表示不建议使用该类或者接口。

示例： /**

* LogManager 类集中控制对日志读写的操作。

* 全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写器， * 读取或写入符合条件的日志纪录。 * @author 张三，李四，王五 * @version 1.2, 2001-03-25 * @see LogIteraotor * @see BasicLog

* @since CommonLog1.0 */

Java编码规范

5.1.8. 类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。

示例： /**

* 注释内容 */

private String logType; /**

* 注释内容 */

public void write()

5.1.9. 成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地方。

5.1.10. 公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输

出参数、返回值、违例等。

格式： /**

* 〈一句话功能简述〉 * 〈功能详细描述〉

* @param [参数1] [参数1说明] * @param [参数2] [参数2说明] * @return [返回类型说明]

* @exception/throws [违例类型] [违例说明] * @see [类、类#方法、类#成员] * @deprecated */

说明：@since 表示从那个版本开始就有这个方法；@exception或throws 列出可能仍出的异常；@deprecated 表示不建议使用该方法。

示例： /**

* 根据日志类型和时间读取日志。

* 分配对应日志类型的LogReader，指定类型、查询时间段、条件和反复器缓冲数， * 读取日志记录。查询条件为null或0表示无限制，反复器缓冲数为0读不到日志。 * 查询时间为左包含原则，即 [startTime, endTime) 。 * @param logTypeName 日志类型名（在配置文件中定义的） * @param startTime 查询日志的开始时间 * @param endTime 查询日志的结束时间

Java编码规范

* @param logLevel 查询日志的级别 * @param userName 查询该用户的日志 * @param bufferNum 日志反复器缓冲记录数 * @return 结果集，日志反复器 * @since CommonLog1.0 */

public static LogIterator read(String logType, Date startTime, Date endTime, int logLevel, String userName, int bufferNum)

5.1.11. 对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方

法所抛出的异常，选择主要的在注释中说明。对于非RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。

说明：异常注释用@exception或@throws表示，在JavaDoc中两者等价，但推荐用@exception标注Runtime异常，@throws标注非Runtime异常。异常的注释必须说明该异常的含义及什么条件下抛出该异常。

5.1.12. *注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注

释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。

5.1.13. *注释与所描述内容进行同样的缩排。

说明：可使程序排版整齐，并方便注释的阅读与理解。示例：如下例子，排版不整齐，阅读稍感不方便。 public void example( ) {

// 注释

CodeBlock One

// 注释 CodeBlock Two }

应改为如下布局。

public void example( ) {

// 注释

CodeBlock One

// 注释

CodeBlock Two }

Java编码规范

5.1.14. *将注释与其上面的代码用空行隔开。

示例：如下例子，显得代码过于紧凑。 //注释

program code one //注释

program code two 应如下书写： //注释

program code one //注释

program code two

5.1.15. *对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。

说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。

5.1.16. *对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case

处理，必须在该case语句处理完、下一个case语句前加上明确的注释。

说明：这样比较清楚程序编写者的意图，有效防止无故遗漏break语句。

5.1.17. *边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再

有用的注释要删除。

5.1.18. *注释的内容要清楚、明了，含义准确，防止注释二义性。

说明：错误的注释不但无益反而有害。

5.1.19. *避免在注释中使用缩写，特别是不常用缩写。

说明：在使用缩写时或之前，应对缩写进行必要的说明。

5.2. 建议

5.2.1. *避免在一行代码或表达式的中间插入注释。

说明：除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。

Java编码规范

5.2.2. *通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成

为自注释的。

说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。

5.2.3. *在代码的功能、意图层次上进行注释，提供有用、额外的信息。

说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。

示例：如下注释意义不大。 // 如果 receiveFlag 为真 if (receiveFlag)

而如下的注释则给出了额外有用的信息。 // 如果从连结收到消息 if (receiveFlag)

5.2.4. *在程序块的结束行右方加注释标记，以表明某程序块的结束。

说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。示例：参见如下例子。

if (...) {

program code1

while (index < MAX_INDEX) {

program code2

} // end of while (index < MAX_INDEX) // 指明该条while语句结束 } // end of if (...) // 指明是哪条if语句结束

5.2.5. *注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用

中文，除非能用非常流利准确的英文表达。

说明：注释语言不统一，影响程序易读性和外观排版，出于维护的考虑，建议使用中文。

5.2.6. 方法内的单行注释使用 //。

说明：调试程序的时候可以方便的使用 /* 。。。*/ 注释掉一长段程序。

本文来源：https://www.bwwdw.com/article/3xit.html

相关文章：

正在阅读：

java编码规范11-29

安全施工协议书实用3篇04-02

2017届高考生物二轮复习专题二十一种群与群落试题04-20

供应链管理课后习题答案07-29

2ASK非相干解调器（包络检波法）设计03-05

农产品集散中心可行性研究报告书08-07

河北省迁安市佳源工贸有限公司铁矿矿产资源开发利用方案终审稿 -04-02

动作经济十二项原则06-06

解读6大名牌香水背后的故事08-05

玻璃幕墙施工要求07-05

上一篇：第二章资金时间价值与风险价值定稿（定稿）下一篇：IE（工业工程）基本内容及技法