JAVA代码规范
- 格式:doc
- 大小:63.50 KB
- 文档页数:5
Java 代码规范
1工程命名规范
1.1--项目名
HumanProject (根据需要修改)brain.engine.
1.2--package 命名
・全部采用小写;
・整个包结构如右图,按统一要求划分; ・不按种类,要按功能类别来划分; ・
所有的资源,不在此结构中;
1.3--class 命名
・首字母大写,以后的单词首字母均大写(即用大写字母来区分单词,并区分类和对象),如ToolBar ;(讲解原因)
・类名中不允许许包含数字。
・类名过长(超过20个字母),只取头文字。
1.4--方法(method )命名
・采用 “动词+目的语”的简洁形式来表述;
・首字母必须小写,以后的单词首字母均大写(即用大写字母来区分单词),如getName(或get_Name);
・下面是动词的例子。
状态的判定is 得到值get 设定值set 追加监听器或值add 删除监听器或值remove 例:判断是否被按下:isPushDown 设定容器的位置:setPanelXY
1.5--变量命名
・开始小写表示变量类型,后面的单词表示含义,单词开头字母大写; 例: String[] columnName; /* column 名 */
int[] columnType; /* column 的类型 */ ・只在循环变量可以使用i 、j 、k 这样的变量名字; ・在Exception 异常变量使用e ,事件变量使用x e 例: me /* mouse event */
ke /* key event */
1.6--常量命名
・所有的文字都大写;
・各个单词用下划线连接; 例: /* model 的最大值 */
public static final int MAX_MODEL = 5;
2 项目规范
2.1—jsp 文件的代码说明
2.1.1 jsp文件命名规则
主功能+子功能。
如:UserDetail
2.1.2 jsp文件首部注释
①功能描述
描述当前页面实现的基本功能
②数据库描述
描述当前页面使用的表结构,字段和生成的结果
③参数描述
说明从其它页面接受的参数,包括发送页面和参数的描述
如:发送页面:a1.jsp参数:a1;功能描述:数据查询的参数
④bean和session的描述
在jsp文件中如果使用到bean和session必须说明bean的结构和session
的相关功能,如:session中的内容、参数、结构,当前页面的使用方法,及初始
化session的页面
2.1.4 tomcat配置
①新建环境变量
set Tomcat_Home = c:\tomcat
set Java_Home = c:\jdk
在classpath中加入oracle的驱动程序C:\Oracle\Ora81\jdbc\lib\classes12.zip
在classpath中加入classpath中加入c:\jdk \lib\tools.jar
在Path中加入c:\jdk1.3\bin\
②tomcat文件路径的设置
在webapps目录下新建brain目录,
打开\tomcat\conf\server.xml文件设置虚拟路径:
<Context path="/brain" docBase="webapps/brain"
crossContext="false" debug="0" reloadable="true"> </Context>
在brain目录下新建四个子目录jsp,html,img,js。
(根据需要和功能)
Jsp目录保存jsp文件,html目录保存html文件
Img目录保存所有的图形
Js 目录保存css样表和JavaScript文件
Servlet程序保存在brain\WEB-INF\classes\目录下
所有的配置文件保存在brain\conf目录下
2.1.5连接数据库
在一个JSP文件中,数据库连接操作必须放在文件的头部,如果在内部有数据连接操作,必须在程序首部加以说明。
2.2—类文件的源代码结构构成
Source Code 以按下面顺序讲述的为标准。
2.2--文件注释
①目的
・写清文件的履历以及变更的内容。
②注释写法规则
・按照Java 标准的comment 标记方法——
JavaDoc 的形式来书写。
・像下面这样,例举适当的选项。
2.5--类注释
①目的:写清楚该类的全体概要。
设计目的,功能。
①记述源文件的信息
②包名
③import 类名
④写该类的注释,包括该类依赖的类,以及被依赖的类集合。
⑤在一个源文件内定义一个类。
(内部类除外)
⑥声明类变量和instance 变量
⑦关于方法的注释
⑧定义该类方法,按照const 、class 、public, protected, private 的顺序定义
・本注释写在文件头。
・按照Java标准的comment 标记方法——JavaDoc的形式来书写。
・在类注释的前一行,用//注释,标明本类涉及到的其它类,如下例。
・下面的例子中,例举了必要的选项。
类的机能概要(用HTML表述)
@参照:参照(在有继承关系的场合写继承元的类名)
@版本:类的版本做成日期,表明最新的版本编号
2.6--方法注释(method注释)
①目的
・写名该方法的使用方法与设计目的,调用方式
②写法规则
・注释应该放在方法的头部
・按照Java标准的comment 标记方法——JavaDoc的形式来书写。
・例举关于下面的事项的必要说明。
关于方法的简单说明(行末记号必须是“。
”)
@参数:Parameter名,Parameter的说明
@异常:例外Class名,说明这个例外在什么场合发生
@返回值:返回值的说明
@参照:参照(记述在类注释里的地方,不要全面的记述)
形式及例子:
2.7--其他注释说明
・有块注释、行注释、后置注释、行末注释四种。
①块注释
・复数行的注释。
・主要记述块的功能概要。
・対象Code采取相同的缩进。
[形式]
/*
* 如果文字列中含有‘\’、‘~’,就把他们对应置换为空格
*/
for (int charCnt = 0; charCnt < lnegth; charCnt++)
{
・・・
}
②行注释
・在对象代码前一行的注释。
・主要是Statement的说明、修改履历。
・和对象代码采取相同的缩进。
・如果需要两行以上,那么和块注释一样。
③后置注释
・写在对象代码末尾的一行非常短的注释。
・短短的写在对象代码的后面。
・主要是变量的说明。
・连续的后置注释采取相同的缩进。
2.8--变量声明
・应该最小限度的使用public变量。
(get,set方法)
・一个声明占一行。
・声明变量得地方应该放在”{ }”的前头。
(for体中的循环变量除外)・instance 变量最好不要使用缺省初始化。
・简单的变量的初始化和声明同时进行。
・不要把变量声明和变量初始值的代入放的太远。