一、命名规范:
- 类名的首字母必须大写。
- 所有成员变量、方法命名时,必须遵守骆驼命名法。
范例:
openAccount();
save();
getFirstName();
isAtEnd(); - 一般运算符两边都必须有空格+、-、*、/、%、=、<、>、!=、<=、>= 两边空格,如:
String name = “zn”;
2 – 1; 2 + 1; 2 * 1; 2 / 1; 2 % 1; 2 > 1;
2 > 1; 2 != 1; 2 <= 1; 2 >= 1;
一元运算可以除外,比如:i++; i--; ++i; --i; - 书写{ }采用如下格式:
public interface Interface {
public void showMessage() {
}
} - 抽象类以Abstract开头;
public class AbstractCollection
- 接口的实现使用Impl结尾;
public class IteratorImpl implements Iterator
- 静态不可变的变量全部使用大写,并且单词之间用_进行分隔:如
public static final int MAX_VALUE = 5;
- 包名由小写字母和少量数字组成,包名统一用代表模块贴切含义的英文单词或缩写;
- 包名一级为com;
- 包名二级为jb;
- 包名三级为班级编号,如s1t001;
- 包名四级为小组名,如crazy;
- 包名五级按功能模块划分等,如oofood
二、注释要求
- 每行注释不超过40个中文字
- 每个类、接口的开头必须多行的详细的功能说明,使用中文注释,包括作者、版本、创建时间等等。
- 每個方法前面都必須使用Javadoc的中文注释,必须说明该方法的作用与目的。
- 每个成员变量必须有单行中文注释,必须说明该成员变量的作用与目的。
类注释
/**
* 作者:张三
* 功能:现存量业务逻辑
* 日期:2003-2-19
*/
方法注释
方法头注释必须包括:方法执行了什么功能,为什么要这样处理;方法处理过程中对对象的那些属性可能进行更改;方法执行前后,对象的状态。- 比较、循环等控制结构必须加注释;
- 在代码的功能并非一目了然的情况下,应当说明为什么要这样做;
- 局部变量必须加注释;
- 复杂难写的代码必须加注释;
如果一系列代码的前后执行顺序有要求,必须注释说明方法开头需要的注释内容:作者、功能、参数说明、返回值、例外、日期、修改日期,修改人,修改原因。举例:
/**
* 作者:张三
* 功能:查询现存量
* 参数: voCond:查询条件VO voAstCond:附加条件VO
* 返回:ResultVO:查询结果
* 例外:DatabaseException
* 日期:2001-04-15
* 修改日期,修改人,修改原因,注释标志:
* 2001-06-16,李四,提高效率,lisi_begin/lisi_end
* 2001-07-16,王五,提高效率,wangwu_begin/wangwu_end
*/
变量注释
要求注释所有的变量(域)。如下所示:/** 标题 */private String title = null;/** 订单VO */private PurchaseBillVO purchaseBillVO = null;如果该注释不用来生成javadoc文件:也可以采用以下形式://标题private String title = null;//订单VOprivate PurchaseBillVO purchaseBillVO = null;

-
华为C语言编程规范(精华总结)
“编写程序应该以人为本,计算机第二。” ...
华为C语言编程规范 C语言编程规范 精华总结 华为C语言技术规范 头文件 -
华为Java编码规范
一、ja...
java python 编程语言 jvm android -
Java编程规范
一、代码整体结构1.1 package com...(com.opendate.swjaynw.config)1.2 import java.* -> javax.* -> 中间件、
java hashmap exception null interface -
华为 C/C++ 编程规范(精华总结)
易于重构的程序必需具备的特征。代码首先是给人读的,好的代码应当可以像文章一样发声朗诵出来。目前软...
powerdesigner hashtable 控制器 uefi dbcp -
Java编程规范(代码规范)--精选
本文介绍精选的Java编程规范(代码规范)。遵守这些规范,代码的bug数
java 字段 正例 编程规范 -
华为软件编程规范和范例#define 操作符 局部变量 初始化 编译器
-
Java编程规范 java编程规范题库
一、单项选择题1、如下哪个是Java中的标识符( D ) A、public B、super C、3number D、width2、如下哪个是Java中的
Java编程规范 java javascript 开发语言 System