【精品】Java编码标准规范.doc

【精品】Java编码标准规范.docJava编码規約
2004 年 09 月 12 S
第1版
承认
查阅
作者
改版履歴
版
年月日
改版理由
作成者
作成部門
初
2004/09/12
新规做成
陈龙
夕文件：
Java编码规约
年月日
作成者
2004/09/12
陈龙
目录
注释 1
类注释 1
方法注释 2
变量注释 3
其他注释 4
块注释 4
方法和内部类 5
使用顺序 5
变量使用及其顺序 6
配列G)記述規則 6
条件分岐 7
if 文(D記述 7
if (D条件式 8
SWITCH 文(J) BREAK 8
循环 9
编码 9
缩进 9
文件断开字符 10
警告方法 10
一行的文字数 11
关于空白 11
关于范围 12
12IMPORT 顺序 13
14
文件：
年月日
作者
Java编码规约
2004/09/12
陈龙


在定义类的那一行的前面用以下形式描述
/**
*处理内容
*
***@author 作者
***@version 版本，改版日，改版内容
*/
处理内容
描述类的主要处理内容
作者
描述程序作成者的名字。
版本，改版日期、改版内容
用逗号分开描述:程序内容变更的版本、日期、改版内容。 新规作成时的版本是10 ,。
日期取编译完成时的日期。
新规作成时，在［改版内容］一栏里写上［新规作成］。
Ex）例
/**
（登陆、修正、参照、削除商品master的数据）
*
***@author NEWER
***@version , 2004-9-12,新规做成
*/
public class NewerFram extends Jframe implements Operations {
※版本升级时的例子
***@version , 2004-9-12,新規作成〈br>
,〈br>
,追力口，assertEquals(String, byte[], byte[])
文件:
Java编码规约
年月日
2004/09/12
作者
陈龙

在定义方法的那一行的前面用以下形式描述
/**
*方法的处理内容
*
***@param
***@return
***@exception*/
参数名参数说明
返回值说明
异常
方法的处理内容
方法处理概要的描述
参数名参数说明
参数的变量名和变量内容
探有多个参数时用多行进行描述.
探没有参数时省略不写.
返回值的说明
返回值内容
探返回值是特定值时(true/false等)，分多行说明各值..
探没有返回值时省略不写.
异常
方法抛出的异常名
探有多个异常时用多行进行描述.
探没有异常抛出时省略不写
Ex)例
/**
指定会话移动时最初得到焦点的
组件默认时为用addKaiwaO登陆的
组件
*
***@param argComp 输入 comp orient
***@param argKaiwaNo 会话号
*/
public void setFirstFocus(JComponent argComp,int argKaiwaNo) {
文件：
年月日
作者
Java编码规约
2004/09/12
陈龙
/**
*取得数据
*
***@return true有数据、false没数据
©exception LogicException 逻辑错误
©exception FatalException FatalException Fatal 错误
©exception SQLException SQL 错误
*/
protected boolean getDataO throws LogicException,FatalException,SQLException {
1 3变量注释行（只适用于实例变量和类变量）
在定义变量的那一行的前面用以下形式描述
/**变量的说明*/
或者
/**
*变量的说明
*/
变量的说明
描述变量的说明
Ex）例
/** 错误 message */
public Label lb I Err Msg = new LabelO；
/**
* message codeo
*/
public String messageCode;
※类变量
定义里加了 static的变量，即使不生成