软件开发编码标准.docx

文档介绍：一、 Java编码标准
(一) 目的
本标准是为了确保编码统一的保守性,定义Java源代码编码方法的标准。
源文件的构成
1、行数
对于源文件,2000行(ment)为基准,超过这个的情况下,就要讨论调整等级/界面设计。
2、同级内定义的顺序
一个源文件只定义一个等级/界面,禁止使用内部级。
同级内定义的顺序如下。
package定义
package名全部小写
package名要取有意义的名字
输入定义
在输入文中禁止使用星号"*"。
「」package是不输入的
级定义
常数定义
级变数/实例变数定义
Constructor定义
Method定义
常数、变数、Constructor、Method均按可视性(public, protected, private)由高到低记载。
界面定义的顺序
界面定义的顺序如下。
package定义
输入文
在输入文中禁止使用星号"*"。
「」package是不输入的
输入定义
能力附加型的界面名在末尾要加上“able”
变数定义
(抽象)Method定义
(三) Comment
ment。
1、ment
ment:利用javadoc命令,记载为了生成HTML的API依据的级・界面和字段・Method等处理说明。
级・界面・列举型,记载以下内容
级名称(行末尾加上英文句号".")
系统名称、业务机能名称
业务名称(种类的话记载种类代码,画面ID单位的话记载画面名,帐票ID单位的话记载帐票名等)
类别
***WEB层的情况***
--ActionForm→ActionForm
-- Action→Action
-- ActionLogic→ActionLogic
-- mand
--checker级等→业务Bean
--编号数据保持级→编号
-- ActionForm以外的数据保持级→Parameter
或Model
***EJB层的情况***
--JustwareApl→JustwareApl
--Service→Service
--Factory,Logic,其他业务级→业务Bean
***其他***
--例外级→Exception
级式样概略(写成1行,末尾加上英文句号".")
版本信息(***@version)
参考文件(***@see)(有参考文件的话记载文件名,不过,是任意的)
作成者(***@author)
导入的版本信息(***@since)
/**
* <pre>
* 级名称:统一目录管理.
* 子系统名称:统一目录查询
* 业务名称:
* 类别: 业务Bean
* 取得事故信息.
* </pre>
* ***@version
* ***@see
* ***@author 黄礼
*/
字段
ment记载的是项目说明(项目名),末尾要加英文句号"."。
/**
* DOI
*/
private String doi = null;
可以写成1行。
Constructor
ment记载下述内容。
处理概要
/**
* DOI特定的情况下,将唯一标识符设定成实例变数。
* ***@param doi 契约号码
*/
public TestClass(String doi) {
= doi;
}
参数(参数名说明)
Method
ment记载下述内容。
(a)处理概要(写成1行,末尾加句号"。"或英文句号"."。)
(b)处理详细(最后一行加句号"。"或英文句号"."。)
(c)参数(参数名说明)
(d)返回值(说明)
(e)Method内可能会被throw的除外(完全指定例外处理级名说明)
/**
* <pre>
* ~ 记载Method的概要~。
* ~ 记载Method的详细~。
* </pre>
* ***@param 参数名说明I/O
* ***@return 返回值说明
* ***@throws 例外处理级名说明
* ***@exception 级名说明
* ***@see 参照源级名
* ***@see 参照文件名
* ***@since 版本信息
*/
(f)参照文件(任意。可多个)
2、ment
ment分为3类,即:“ment”“ment”“ment”。
ment
ment的记载,记载数据构造和算法等。
ment化的情况下,也会使用。
ment的对象行保持相同缩进,ment的正前方加入空行。
/*
* ment
* ment
*/
ment