JAVA编码规范Word文档格式.docx
《JAVA编码规范Word文档格式.docx》由会员分享，可在线阅读，更多相关《JAVA编码规范Word文档格式.docx（25页珍藏版）》请在冰豆网上搜索。
以下为主要的文字转义符：
文字转义符
表示符号
&
lt;
gt;
amp;
quot;
“
nbsp;
（空白）
reg;
®
2.1.2HTML基本信息
（1）文档型声明（DOCTYPE声明）
1记录所使用的HTML的版本号。
!
DOCTYPEHTMLPUBLIC"
-//W3C//DTDHTML4.01Transitional//EN"
（2）字符集指定
1为防止在浏览器上出现乱码，指定以下字符集。
METAhttp-equiv="
Content-Type"
content="
text/html;
charset=GB2312"
>
2.1.3
标题
1各画面的标题组成中要添加功能名。
2标题长度为20个字符以内。
2.1.4链接
（1）指定链接名
1指定链接名以便明了链接地址的内容。
2指定内容标题、一览页的标题等。
（2）指定A元素的标题属性
1在A元素里、通过标题属性来说明连接地址。
记述例：
Ahref=””title="
TTNI"
TTNI-C<
/A>
（3）使用<
A>
时，<
不换行，且记述在作为链接对象的字符串和图标后。
2.1.5图片
（1）图片文件的种类
1使用GIF、JPEG、PNG的其中一种。
2.1.6字体
（1）指定字体
1指定标准字体为浏览器的默认字体,不指定不同机种的字体。
2字体的大小、粗体、斜体、颜色等，根据样式表来指定。
3.
JavaScript开发规范
以下为JavaScript的开发规范。
3.1基本方针
3.1.1适用场合
JavaScript基本上在实现以下功能的场合下使用。
1指定业务流程的迁移位置。
2指定从错误画面返回时的迁移位置。
3子画面的打开关闭。
4确认、选择对话框的显示。
5复选框的ON/OFF控制等。
6显示MESSAGE等。
7输入项目的检查等。
8其他特殊操作等。
3.2命名标准
以下为JavaScript的命名标准。
3.2.1变量名
1遵循Java开发规范的类变量、实例变量的命名。
3.2.2函数名
1遵循Java开发规范的方法的命名。
3.3
注释
以下为JavaScript的注释标准。
1注释的开始位置，要与相应程序的记述位置对齐。
2程序部分，要记述每个处理单位的处理概要。
3程序部分的注释，要写在程序执行的前一行。
4为了在浏览器的源代码显示中不显示出注释，作为JSP的注释来记述。
5JavaScript脚本文件中记述的头注释，如下所示。
记述例：
%
//============================================
// 【概要】项目行追加函数
// 【输入值】projectCd项目代码
// projectNm项目名
// 【返回值】返回值的说明
%>
functionaddProjectRow（projectCd,projectNm）{
……
}
3.4JavaScript的记述
以下为JavaScript的记述。
3.4.1整体
1语句末尾必须加上「；
（分号）」结束。
2文字字符串必须用「’（单引号）」围起来。
3.4.2缩进
1为方便阅读程序，插入缩进。
2缩进量使用4个半角空格，不使用Tab键。
3.4.3嵌套
1If语句、while语句、for语句等的嵌套，原则上最多三级。
3.4.4空白行的记述
1过程内的处理与处理间，为方便分段，插入空白行。
3.4.5按钮TYPE
1在JavaScript中控制动作的按钮的TYPE，使用button，而不使用Submit（这是为了防止在不能使用JavaScript的环境下，点击按钮时产生错误的提交处理）。
4.
JSP开发规范
以下为JSP的开发规范。
4.1基本方针
4.1.1JSP源文件的构成
以下为JSP源文件的构成。
主体JSP（IncludeJsp）
Page指令语句
Taglib指令语句
Page指令
Include指令语句
获取Contents
HTMLHead
Include指令
HTMLBody
JS、CSS链接
HTMLFoot
4.1.2Page指令
以下为Page指令内的记述方法。
%@pagecontentType="
charset=GB2312"
pageEncoding="
GB2312"
%>
（*）
%@pageimport="
jp.xxxx.mon.ConstantComIF"
（*）行必须有
4.1.3Taglib指令
以下为使用Taglib时，taglib指令内的记述方法。
%@taglibprefix="
apachetag"
uri="
http:
//www.apache.co.jp/taglib/foundation/apachetag"
4.1.4Include指令
以下为Include指令的记述方法。
%@includefile="
../common/common_variable.jsp"
4.1.5JS、CSS链接
以下为使用外部Script及样式表时的记述方法。
linkrel=”stylesheet”href=”xxxx“type=”text/css”>
4.1.6HTMLBody
关于HTMLBODY、HTML源程序，请参照2.HTML开发规范、3.JavaScript开发规范。
4.2命名标准
以下为JSP的命名标准。
1文件名
・遵循程序命名规则。
2源程序
・变量、常量、方法的命名标准，遵循JAVA开发规范。
4.3注释
以下为JSP的注释标准。
1逻辑处理部分以功能为单位来注释。
2考虑到源代码的可维护性，方法和实例变量需遵循JAVA开发规范。
4.4JSP的记述
关于JSP的记述方法，有如下注意事项。
4.4.1整体
1对值的显示，采用<
%=～%>
。
4.4.2字符集
1源文件编码、HTML输出文件编码采用GB2312。
2JSP源文件用GB2312制作。
3JSP源文件内的JSPPage指令的content-type和HTMLmeta标签的content-type设定为”GB2312”。
5.
JAVA开发规范
以下为JAVA的开发规范。
5.1命名标准
以下为基于JAVA语言开发的项目的命名标准。
5.1.1Package
（1）Package名
1Package名采用aaa.xxxx（aaa.xxxx根据项目需要自行定义）。
2命名形式：
Camelcase3制作有意义的包名进行管理。
（2）文件
1遵循程序命名规则。
5.1.2命名规则
（1）命名形式的定义
本书中所使用的命名形式定义如下：
①Pascalcase
将各单词的第一个字母大写。
适用于由3个及3个以上字符组成的标识符。
例） MyClass
②Camelcase
将第一个单词小写。
之后的每个单词第一个字母大写。
例） myParameter
③Uppercase
将标识符的所有字母大写。
仅用于2个及2个以下的字符组成的标识符。
④上述以外的用语
上述以外的情形，使用以下用语。
前缀（Prefix）
后缀（Suffix）
（2）通用规则
①大小写
不要使用不一致的写法。
例） index和Index
②缩略形式
为避免用语混乱，且可在多语言情况下操作，需遵循下述缩略语的使用规则。
a.类名和接口名尽量不使用缩略语。
例） err → error
proc → procedure
b.避免使用计算机领域不常用的缩略语。
c.用众所周知的缩略语代替冗长的词组名。
例：
将UserInterface缩略为UI。
d.超过两个字符的缩略语，需使用Pascal形式或Camel形式。
HtmlButton或HTMLButton。
两个字符的缩略语则全部采用大写形式。
用System.IO，而不用System.Io。
③匈牙利记法
不使用。
例） intIndex → index
④下划线
※常量、事件的情形可以使用。
（1）类
（A）业务类
1命名形式：
Pascalcase
例）OpcAlarmListBean
（B）Action类Pascal
功能名【首字母大写】+Action
例）OpcAlarmListAction
（C）Form类
功能名【首字母大写】+ Form
例）OpcAlarmListForm
（D）DAO类
功能名【首字母用大写】+ DAO
例）OpcAlarmListDAO
（2）抽象类
（3）枚举型
Camelcase2命名方法：
使用单数形式的名称。
（例）enumcamelCase
3注意事项：
不用Enum等后缀。
（4）静态字段
Camelcase
（5）参数
（例）stringParse（inttargetIndex）;
2命名方法：
不使用说明参数类型的名称，而使用说明参数含义的名称。
（6）接口
使用后缀「Interface」。
例）FileInterface
（7）异常类
使用后缀「Exception」。
例）ApplicationException
（8）返回boolean的方法
is＋形容词、can＋动词、has＋过去分词、第三人称单数动词、第三人称单数动词＋名词。
（正确例）isEmpty（）、canGet（）、hasChanged（）、contains（）、containsKey（）
（错误例）empty（） …「设为空」的说法有动词含义。
（9）常量
Uppercase2命名方法：
分隔单词，使用下划线‘_’。
（10）局部变量
（11）局部变量
Camelcase2集合的名称应能体现其为集合。
例）ListsearchResultList;
（12）方法名
Camelcase2用动词＋名詞为基本形，使用带处理含义的名称。
例）getData（）（获取数据）
getDAO（）（获取DAO）
deleteData（）（删除数据）
3动词使用以下定义好的词。
动词（中文）
动词（物理名）
使用实例
制作
make
makeReport
转换
to
toString
获取
get
getAttribute
设定
set
setAttribute
判定
is
isYear
计算
calc
calcTax
输入
input
inputSlip
输出
output
outputSlip
注册
register
registerEntry
更新
update
updateEntry
显示
display
displaySlip
打印
print
printReport
参照
reference
referenceSlip
删除
delete
deleteData
关闭
close
closeWindow
4DAO关联的方法，使用SQL命令（select等）＋名词（作为对象的表名）。
但是类名中明确记录了表名时，则省略。
（表名除去前缀）5对象为多表时，使用非表名的含处理含义的名词。
6用上述命名方式形成的方法名不是唯一时，则按条件的key，OrderBy的key的顺序来指定。
例）selectAcceptSlipAll（）
selectAcceptSlipAcceptNoAcceptNoDesc（）
insert（）
updateSlipStatus（）
5.2注释
5.2.1注释位置
注释位置如下所示。
例）SampleClass.java
publicclassSampleClass{
......
publicfunctiongetSample（）{
}
5.2.2文件头
文件头注释不参考JavaDoc标准，记述方式如下：
/*
*【项目名称】：
○○○系统
*
*【功能概要】：
○○○功能
*【更新履历】：
Ver更新日期 担当者 修改内容
*01.00YYYY/MM/DD XXXXXX 新建
*01.01YYYY/MM/DD XXXXXX XXX
*/
5.2.3类
类注释参考JavaDoc标准，记述方式如下：
/**
*<
pre>
*功能名
*记述类的功能概要
/pre>
*
*@author记述制作者
5.2.4方法
方法的注释基准如下所示。
（1）方法开头的注释
1类注释应在「/**」～「*/」之间记述。
2在「*」后记述功能、概要、备注（可省略）。
3在「*@param」后记述参数名及参数的说明。
4在「*@return」后记述返回值的说明。
5在「*@exception」后记述异常类名及异常的说明。
/**
*<
功能概要>
*@param<
记述参数名>
<
记述参数的说明>
*@return<
记述返回值的说明>
*@exception<
记述异常类名>
记述（异常发生的条件等）说明>
*/
例）
/**
*<
按指定格式返回数值字符串。
*@paramnum 参数的说明。
*@return格式转换后的字符串。
*@exception ArithmeticException状态为0时发生。
*/
（2）
方法处理说明注释
1单行注释用「//<
处理说明>
」。
2块注释时使用「/*・・・*/」。
3下列处理必须进行注释。
A）处理的模块单位
B）if语句
C）方法调用
D）变量
（3）setter、getter方法注释
1不必进行方法开头注释。
2setter、getter方法中使用的变量，用Javadoc形式注释。
例）
/**类的变量声明*/
privateStringInhouseCd=null;
5.3JAVA的记述
JAVA的记述标准如下所示。
5.3.1整体
处理整体的记述标准如下所示。
1缩进使用4个半角空格，不可以使用tab键进行缩进。
2原则上每行不超过80个字符（但是，如果因为换行而不易读解时、可以不必遵守此规则）。
・命令行超过80个字符时，可在逗号后面或在优先级较低的运算符前换行，或者使用局部变量。
・声明行超过80个字符时，在extendsimplementsthrows节，或在参数的逗号处换行。
换行处开始2行以后的缩进对齐。
3「{}」的后面，不记述声明语句直接换行（注释除外）。
4每行不可以记述2个以上的声明语句。
5条件语句（if、else、while、for、do-while）的「{}」不可以省略。
6无声明语句时，不记述空的「{}」模块。
7控制条件要求计数时，使用「for语句」；
若只需控制循环终了条件，则使用「while语句」。
8尽量避免循环处理中的对象生成。
9原则上循环处理中不使用「try/catch」块语句。
5.3.2声明语句
本项目的声明文的记述标准如下。
（1）Import语句
Import语句的记述标准如下。
1使用类时、用import语句声明使用的Package。
2按照Java项目、javax项目、其他项目的顺序记述，并按照Package名、类名升序排列。
3Import语句中指定类时，应使用“Package名．类名”进行指定、不使用星号「*」。
但是、如果同一个Package中导入3个以上的类时，可以使用星号「*」。
（2）class、interface声明
class、interface声明的记述标准如下。
1声明语句开始的花括号「{}」应在该行末尾。
2声明语句结束的花括号「{}」应与对应语句采用相同的缩进。
3class、interface的声明，应按照访问修饰词「public」、「protected」、默认值、「private」的顺序声明。
4在声明语句行只包括上述内容中的花括号。
正
误
classSampleextendsObject{
语句;
classSampleextendsObject
{
（3）属性（类变量、实例变量）声明
属性声明的记述标准如下所示。
1属性声明应按照访问修饰词「public」、「protected」、default、「private」的顺序进行声明。
2属性声明时，每行只包括一个属性。
（4）常量声明
常量声明的记述标准如下所示。
1常量、不被继承的类、不被重写的方法应使用「final」进行声明。
2尽量使用常量（用Final定义）,避免直接使用数值。
但是,for循环中的记数值（如0、1、-1等）,即使直接使用数值也不会造成可读性的低下，所以不在此限制之列。
（5）局部变量的声明
局部变量声明的记述标准如下。
1每行只记述一个声明
longlevel=0;
longsize=256;
longlevel,size;
2变量声明时，应在代码块的开头进行声明，并进行初始化。
voidsample（longstart）{
longlevel_=start+1;
longsize=0;
语句;
longlevel=start+1;
3标识符之间插入1个空格，不使用Tab键对齐。
longlevel;
longsize;
4不在For语句的括号内声明局部变量。
但是循环计数器变量则作为例外可在括号内声明局部变量。
5数组应在数据类型后接[]进行声明、并进行初始化。
long[]iArray={1,2,4,8};
longiArray[]={1,2,4,8};
longARRAY_SIZE=10;
String[]strArray=newString[ARRAY_SIZE];
StringstrArray[]=newString[ARRAY_SIZE];
6尽量不要使用2元以上的数组。
7子模块中、不声明与子模块外部已经声明了的局部变量名称相同的变量。
8没有必要使用类变量和实例变量的地方，尽量使用局部变量。
（6）方法定义
方法定义的记述标准如下。
1一个方法只进行一种处理。
2方法根据每个机能进行排列。
3声明语句开始的花括号「{}」应在该行末尾记述。
4声明语句结束的花括号「{}」应与对应的声明语句的缩进相同。
sample（longi,longj）{
longmethod（）{
sample（longi,intj）
{
5.3.3语法
语法的记述基准如下：
1每行只记述一个语句。
2在逗号、「for语句」后、算术运算符、赋值运算符的前后插入半角空格。
升级会员 