java接口命名规范Word下载.docx
《java接口命名规范Word下载.docx》由会员分享，可在线阅读，更多相关《java接口命名规范Word下载.docx（12页珍藏版）》请在冰豆网上搜索。
net.vschool
2、在包名的接下来一个单词为模块的名称。
用户模块，包名为net.vschool.user
3、关于模块的访问操作，采用分层形式,一般分为：
dao层操作：
一般定义在net.vschool.xxx.dao中，其中xxx为模块名称。
service层操作：
一般定义在net.vschool.xxx.servie中。
web层操作：
一般定义在net.vschool.xxx.action中。
如下关于用户模块的例子：
net.vschool.user
net.vschool.user.dao
net.vschool.user.action
net.vschool.user.service
二类名的书写规范（class）
类名必须使用名词，如果一个类名内含多个单词，那么各个单词第一个字母大写，后续字母小写，起伏呈驼峰状，人称驼峰式命名。
给类名命名时，必须保证准确、简洁且容易理解。
尽量使用完整单词，避免使用缩写词（除了大家公认的）
2.1类的命名
2.1.1一般要求
2、参照java驼峰命名法，类名的首字母必须采用大写的形式，如果类名为多词组合而成的话，那么每个词的首字母必须采用大写。
studentanswer.java
3、当要区别接口类和实现类的时候，可以在类的后面加上“impl”。
如：
接口类：
userinterface.java接口实现类：
userinterfaceimp
4、推荐实体类没有后缀名。
2.1.2实际应用
应用系统中经常应用分层，dao层（数据库访问）、service层（业务处理）、web层（页面控制action类），每一层的类的名称尽量带上该层后缀。
1、dao层
a、接口类：
采用javabean+interface+dao的形式来定义,即，实体对象+interface+dao。
用户对象接口类：
userinterfacedao，其中xxx为模块名称。
b、实现类：
采用javabean+interface+impl+dao的形式来定义,即，实体对象+interface+impl+dao。
用户对象实现类：
userinterfaceimpldao
2、service层
采用xxx+interface+service的形式来定义,即，模块+interface+service。
用户管理接口类：
usermsginterfaceserviec
采用xxx+interface+impl+service的形式来定义,即，模块+interface+impl+service。
用户管理实现类：
usermsginterfaceimplserviec
3、web层（action类）
a、实现类：
采用县xxx+operator+action的形式来定义,即，模块+操作+action。
如用户模块user+删除操作delete+action=userdeleteaction
2.1变量的命名
2.2.1普通变量
2.2.2.1一般要求
1、选择有意义的名字，能快速地传达该变量的用途。
2、参照java驼峰命名法，首字母以小写开头，每个单词首字母大写（第一个单词除外）。
2.2.2.2实际应用
1、变量命名采用基本结构为typeVariablename，使用3字符前缀来表示数据类型。
例如，定义一个整形变量：
intdoccount，其中int表明数据类型，后面为表意的英文名，每个单词首字母大写。
数据类型或对象类
型
byte变量前缀bye1、做数组用时，再加前缀-a,如字符串数组：
astr，备注
4、服务层方法，根据方法的行为命名，只描述方法的意义，而不采用方法的目的命名。
比如系统的添加新用户，用户可以前台注册，也可以管理员后台添加，方法会被重用，所以最好不要用使用register，采用add会更好写。
避免使用与web层相关的方法。
5、web层方法最好是贴近web的语言，如register，login，logout等方法。
三注释的书写规范（javadoc）
java除了可以采用我们常见的注释方式（//、/**/）之外，java语言规范还定义了一种特殊的注释，也就是我们所说的javadoc注释，以/**开头，而以*/结束，javadoc注释可以被自动转为在线文档，省去了单独编写程序文档的麻烦。
推荐使用。
javadoc注释主要涉及范围：
类、属性、方法。
例如：
复制代码代码如下:
packageorg.ietf.jgss;
.inetaddress;
importjava.util.arrays;
/**
*该类的整体性描述。
*
*@author作者
*@version1.0,05/22/07
*@since1.0
*/
publicclasschannelbinding{
*对该变量的备注信息
privateinetaddressinitiator;
privateinetaddressacceptor;
privatebyte[]appdata;
*对该类的构造函数的备注信息。
*@paraminitaddr对参数的备注。
*@paramacceptaddr对参数的备注。
*@paramappdata对参数的备注。
publicchannelbinding（inetaddressinitaddr,inetaddressacceptaddr,byte[]appdata）{
initiator=initaddr;
acceptor=acceptaddr;
if（appdata!
=null）{
this.appdata=newbyte[appdata.length];
java.lang.system.arraycopy（appdata,0,this.appdata,0,appdata.length）;
}
*对该类的具体一函数的备注信息
*@paramobj参数的备注信息
*@return返回值的备注信息
publicbooleanequals（objectobj）{
if（this==obj）
returntrue;
if（!
（objinstanceofchannelbinding））
returnfalse;
channelbindingcb=（channelbinding）obj;
returnarrays.equals（appdata,cb.appdata）;
四其他书写规范
篇二：
java代码命名规范
代码命名规范
1工程总述
本项目的整体命名规范，在java语言的命名规范的基础上，做出更符合这次项目开发的规定，下面的表格是java命名规范的一些规定，之后的分述中，我们还有更详尽的约束。
java程序组成包名类名接口
命名规范
英文单词全部小写
每一个单词的第一个字母都大写每一个单词的第一个字母都大写
第一个英文单词的第一个字母小写其他单词
属性
的第一个字母大写
方法
英文单词全部大写，并且每个单词之间用下划
常量
线
隔开
工程全部存放在wap文件夹下。
wap文件夹下结构如下文件夹srcwap
资源命名规则资源业务分类cp单位信息cp管理员信息上传图片信息信息机型消费过滤字普通用户
作用
存放java源文件存放jsp页面及资源文件
命名cpbusinesscpcategorycpinfocpmanagerinfodownpicgroupinfomanagemobileuapaymentmanageruncommonwordusermanager
备注
2命名空间（namespace）
项目文件的命名空间采用com.xdtech.wap+包名的命
名方式
例如，用户
com.xdtech.wap.po.user
3src源文件
所有的源文件都在src文件夹下，所属com.xdtech.wap包。
该包下的文件和文件夹命名我们按照本系统的功能来描述。
文件夹名（包名）作用dao
项目dao层代码
文件命名见规则3.1
表名.java例如，
po
项目po层代码
user.java
hibernate的映射、配置文表名.hbm.xml例如，
modelservicewebutil
件
项目service层代码项目web层代码项目的通用类
单元测试代码，是对
test
service层的测试
见规则3.5user.hbm.xml见规则3.2见规则3.3见规则3.4
3.1dao
3.1.1
文件夹命名
在dao中只有1个文件夹——hibernate，里面存放的是dao文件，所有的dao类都继承自basedao.java并实现generatebasedao接口。
dao文件的命名规则：
资源名+dao.java
3.1.2
文件命名
文件
继承自hibernatedaosupport，是所有dao
basedao.javainterfacedao.java
类的父类
项目中dao接口的父接口（标识接口）继承自interfacedao，所有dao类都要实
generatebasedao.java现它
3.1.3
方法的命名
命名
增加记录删除记录修改记录
savedatabean（）
removedata+byid（参数为id时）updatedatabean（）
loaddatabean（）查询单条记录
Finddatalist（）查询记录查询多条记录
querycount（）查询记录条数
3.2service
3.2.1
文件夹
文件夹命名（包名）作用
后台系统管理员的
admin
service层代码
资源名+serviceimpl文件命名
后台cp管理员的所有的service类都继承自
manageservice层代码
baseservice类，
前台普通用户的并实现generateservice接口
face
篇三：
1.java开发命名规范
1.1包（package）的命名
package的名字应该都是由小写单词组成。
前缀全部小写并且是一个顶级域名，通常是com，gov，edu，mil，net，org；
后续部分要求的命名规则如下：
1.2类（class）命名
1.2.1domain层
以“画面id”方式命名
例：
待办事项大分类，画面id:
pm110101
命名为：
1.2.2web层
以“画面id+action”方式命名
pm110101action
1.2.3service层
以“画面id+机能名称+service”方式命名
pm110101，机能：
删除
pm110101deleteservice
1.2.4sqlmap层
以“画面id+_sqlmap”方式命名
pm110101_sqlmap
1.2.5其它类命名
采用大小写混合方式，每个单词的首字母大写，尽量使类名简洁而富有描述性能。
使用完整的单词，避免缩写词（除非缩写词被广泛的使用）
类作用eims的文件操作工具类
eimsFileutil
1.3接口（interface）命名
命名规章与类命名规则相同，详细请查看1.2
1.4方法（method）命名
采用大小写混合方式，第一个单词的首字母小写，其后单词的首字母大写。
例：
执行一个service
executeservice
1.5变量（Variable）命名
采用大小写混合阿飞脑梗塞，第一个单词的首字母小写，其后单词的首字母大写。
变量尽量避免一个字母，除非是一次性的临时变量，临时变量通常取名为i、j、k、m和n，它们一般用于整形；
c，d，e，它们一般用于字符型
stringdataResult
FilepdfFile
1.6常量（constant）命名
常量名称全部采用大写，每个单词以“_”隔开
staticfinalintmax_width=999;
staticfinalintmin_height=555;
升级会员 