java实体类命名规范.docx
《java实体类命名规范.docx》由会员分享，可在线阅读，更多相关《java实体类命名规范.docx（12页珍藏版）》请在冰豆网上搜索。
java实体类命名规范
竭诚为您提供优质文档/双击可除
java实体类命名规范
篇一：
java各种命名规范
定义规范的目的是为了使项目的代码样式统一，使程序有良好的可读性。
包的命名（全部小写，由域名定义）
java包的名字都是由小写单词组成。
但是由于java面向对象编程的特性，每一名java程序员都可以编写属于自己的java包，为了保障每个java包命名的唯一性，在最新的java编程规范中，要求程序员在自己定义的包的名称之前加上唯一的前缀。
由于互联网上的域名称是不会重复的，所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。
例如：
net.frontfree.javagroup
类的命名（单词首字母大写）
根据约定，java类名通常以大写字母开头，如果类名称由多个单词组成，则每个单词的首字母均应为大写例如testpage；如果类名称中包含单词缩写，则这个缩写词的每个字母均应大写，如：
xmlexample,还有一点命名技巧就是由于类是设计用来代表对象的，所以在命名类时应尽量选择名词。
例如：
graphics
方法的命名（首字母小写，字母开头大写）
方法的名字的第一个单词应以小写字母作为开头，后面的单词则用大写字母开头。
例如：
drawimage
常量的命名（全部大写，常加下划线）
常量的名字应该都使用大写字母，并且指出该常量完整含义。
如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词。
例如：
max_Value
参数的命名
参数的命名规范和方法的命名规范相同，而且为了避免阅读程序时造成迷惑，请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。
javadoc注释
java除了可以采用我们常见的注释方式之外，java语言规范还定义了一种特殊的注释，也就是我们所说的javadoc注释，它是用来记录我们代码中的api的。
javadoc注释是一种多行注释，以/**开头，而以*/结束，注释可以包含一些html标记符和专门的关键词。
使用javadoc注释的好处是编写的注释可以被自动转为在线文档，省去了单独编写程序文档的麻烦。
例如：
/**
*thisisanexampleof
*javadoc
*@authordarchon
*@version0.1,10/11/20xx
*/
在每个程序的最开始部分，一般都用javadoc注释对程序的总体描述以及版权信息，之后在主程序中可以为每个类、接口、方法、字段添加javadoc注释，每个注释的开头
部分先用一句话概括该类、接口、方法、字段所完成的功能，这句话应单独占据一行以突出其概括作用，在这句话后面可以跟随更加详细的描述段落。
在描述性段落之后还可以跟随一些以javadoc注释标签开头的特殊段落，例如上面例子中的@auth
er和@version，这些段落将在生成文档中以特定方式显示。
变量和常量命名
变量的命名
主要的的命名规范有以下三种：
camel标记法:
首字母是小写的,接下来的单词都以大写字母开头
pascal标记法:
首字母是大写的,接下来的单词都以大写字母开头
匈牙利标记法:
在以pascal标记法的变量前附加小写序列说明该变量的类型
在java我们一般使用匈牙利标记法，基本结构为scope_typeVariablename，它使用1-3字符前缀来表示数据类型，3个字符的前缀必须小写，前缀后面是由表意性强的一个单词或多个单词组成的名字，而且每个单词的首写字母大写，其它字母小写，这样保证了对变量名能够进行正确的断句。
例如，定义一个整形变量，用来记录文档数量：
intdoccount，其中int表明数据类型，后面为表意的英文名，每个单词首字母大写。
这样，在一个变量名就可以反映出变量类型和变量所存储的值的意义两方面内容，这使得代码语句可读性强、更加容易理解。
byte、int、char、long、float、double、boolean和short。
数据类型/前缀（附）
byteb
charc
shortsh
inti
longl
charc
strings
floatf
doubled
hashtableh
[]arr
listlst
Vectorv
stringbuffersb
booleanb
bytebt
mapmap
objectob
对于在多个函数内都要使用的全局变量，在前面再增加“g_”。
例如一个全局的字符串变量：
g_struserinfo。
在变量命名时要注意以下几点：
·选择有意义的名字，注意每个单词首字母要大写。
·在一段函数中不使用同一个变量表示前后意义不同的两个数值。
·i、j、k等只作为小型循环的循环索引变量。
·避免用Flag来命名状态变量。
·用is来命名逻辑变量，如：
blnFileisFound。
通过这种给布尔变量肯定形式的命名方式，使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。
·如果需要的话，在变量最后附加计算限定词，如：
cursalessum。
·命名不相包含，cursales和cursalessum。
·staticfinal变量（常量）的名字应该都大写，并且指出完整含义。
·如果需要对变量名进行缩写时，一定要注意整个代码中缩写规则的一致性。
例如，如果在代码的某些区域中使用intcnt，而在另一些区域中又使用intcount，就会给代码增加不必要的复杂性。
建议变量名中尽量不要出现缩写。
·通过在结尾处放置一个量词，就可创建更加统一的变量，它们更容易理解，也更容易搜索。
例如，请使用strcustomerFirst和strcustomerlast，而不要使用strFirstcustomer和strlastcustomer。
常用的量词后缀有：
First（一组变量中的第一个）、last（一组变量中的最后一个）、next（一组变量中的下一个变量）、prev（一组变量中的上一个）、cur（一组变量中的当前变量）。
·为每个变量选择最佳的数据类型，这样即能减少对内存的需求量，加快代码的执行速度，又会降低出错的可能性。
用于变量的数据类型可能会影响该变量进行计算所产生的结果。
在这种情况下，编译器不会产生运行期错误，它只是迫使该值符合数据类型的要求。
这类问题极难查找。
·尽量缩小变量的作用域。
如果变量的作用域大于它应有的范围，变量可继续存在，并且在不再需要该变量后的很长时间内仍然占用资源。
它们的主要问题是，任何类中的任何方法都能对它们进行修改，并且很难跟踪究竟是何处进行修改的。
占用资源是作用域涉及的一个重要问题。
对变量来说，尽量缩小作用域将会对应用程序的可靠性产生巨大的影响。
关于常量的命名方法，在jaVa代码中，无论什么时候，均提倡应用常量取代数字、固定字符串。
也就是说，程序中除0，1以外，尽量不应该出现其他数字。
常量可以集中在程序开始部分定义或者更宽的作用域内，名字应该都使用大写字母，并且指出该常量完整含义。
如果一个常量名称由多个单词组成，则应该用下划线“_”来分割这些单词如：
num_days_in_week、max_Value。
篇二：
java命名规范
anyFo
代码编写规范主编：
安坤版本号：
V.0711
目录
目录..................................................................................................................................................2
1java包规范..............................................................................................................................3
1.1包结构规范...................................................................................................................3
1.2包命名规范...................................................................................................................3
2类规范.......................................................................................................................................3
2.1类命名规范...................................................................................................................3
2.2接口命名规范...............................................................................................................4
2.3接口实现类名规范.......................................................................................................4
2.4抽象类类名规范...........................................................................................................4
a）抽象类的子类类名规范...................................................................................................4
2.5函数命名规范...............................................................................................................4
2.6变量命名规范...............................................................................................................4
2.7常量名规范...................................................................................................................4
2.8eclipse编码规范模板..................................................................................................5
3注释规范...................................................................................................................................5
3.1类注释规范...................................................................................................................5
3.2接口注释规范...............................................................................................................5
3.3函数注释规范...............................................................................................................5
3.4代码注释规范...............................................................................................................5
1java包规范
1.1包结构规范
1．包名最前面一定是企业或组织的官方站点网址，如：
企业为，则包的最前面为cn.anyfo，称之为“根包”
2．每个产品或项目都有自己的名字，在根包名后面应该加上自己的名字，而项目的所有东西都放在以自己名字命名的包下，如：
通用权限系统“Forget”，则它的包名为：
cn.anyfo.forget
3．几乎每个项目都分为前台和后台两部分代码，分别放在xxx.face和xxx.business下，如：
a）cn.anyfo.forget.faces
b）cn.anyfo.forget.business
4．不管前台还是后台，代码都分模块存放，模块下面又分子模块，则跟着的包名又按照各模块的结构建立，如：
a）cn.anyfo.forget.business.user_system.base_info
b）cn.anyfo.forget.business.user_system.referrence
5．如果后台用的是ejb3，则每个功能点分为两个部分
a）persistence里的实体－包名定为entities
b）前台能直接调用的会话bean－包名定为logic
c）则包结构为：
.anyfo.forget.business.user_system.base_info.logic（这个模块的会话bean的类和接口都放在这里）
.anyfo.forget.business.user_system.base_info.entities（这个模块的所有实体都放在这里）
1.2包命名规范
1．包名中绝对不允许出现大写字母。
2．如果需要将包名中的各单词分开，单词间用“_”连接。
如：
user_system
3．包名单词要能顾名思义。
2类规范
2.1类命名规范
1．类名中，每个单词开头字母要大写，其他字母要小写，如：
Filemanager
2．类名单词要能顾名思义
2.2接口命名规范
1．接口名要以“i”开头，如：
idriver
2．接口中每个单词开头字母要大写，其他字母要小写，如：
idriver
2.3接口实现类名规范
1．接口实现类的名字要以impl结尾，如：
cameradriverimpl
2．遵循前面说的
2.4抽象类类名规范
1．抽象类要以“a”开头，如：
adriver
2．遵循前面说的类命名规范
a）抽象类的子类类名规范
1．抽象类的子类要以“xtd”结尾，如：
cameradriverxtd
2．遵循前面说的
2.5函数命名规范
1．函数名中，首单词的每个字母都要小写，其他单词的开头字母大写，剩下字母小写，如：
querystudentlist（…）
2．函数名称要能顾名思义
2.6变量命名规范
1．变量名中，首单词的每个字母都要小写，其他单词的开头字母大写，剩下字母小写，如：
studentname
2．变量名称要能顾名思义
2.7常量名规范
1．常量的每个字母都大写
2．各个单词间以“_”隔开
3．常量名称要能顾名思义
4．如：
max_count
2.8eclipse编码规范模板
3注释规范
3.1类注释规范
1．类的申明前面要添加该类的整体功能
3.2接口注释规范
1．跟类注释规范一致
3.3函数注释规范
1．注释第一航为函数功能
2．然后是各参数意义
3．然后是返回值意义
4．然后是最后一个编写者姓名和最后一次修日期
3.4代码注释规范
1．每个小功能块都应该又一个注释，让维护者可以轻松看懂
篇三：
java开发命名规范
作者：
字体：
[增加减小]类型：
转载时间：
20xx-10-24我要评论
包名的书写规范（package）推荐使用公司或机构的顶级域名为包名的前缀，目的是保证各公司/机构内所使用的包名的唯一性。
包名全部为小写字母，且具有实际的区分意义使用前注意事项：
1、由于java面向对象编程的特性,在命名时应尽量选择名词
2、驼峰命名法（camel-case）:
当变量名或函式名是由一个或多个单字连结在一起，而构成的唯一识别字时，首字母以小写开头，每个单词首字母大写（第一个单词除外）。
如：
myFirstname
一包名的书写规范（package）
推荐使用公司或机构的顶级域名为包名的前缀，目的是保证各公司/机构内所使用的包名的唯一性。
包名全部为小写字母，且具有实际的区分意义。
1.1一般要求
1、选择有意义的名字，能快速地传达该类的用途。
2、所有包的命名必须采用小写英文字母。
1.2实际应用
应用系统中经常应用分层，dao层（数据库访问）、service层（业务处理）、web层（页面控制action类）。
1、包名的前几个为固定名称,如果是网站的话，采用网站的域名的反写，如果域名还没有确定的话，采用公司固定的几个名称。
如：
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一般要求
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层
a、接口类：
采用xxx+interface+service的形式来定义,即，模块+interface+service。
如：
用户管理接口类：
usermsginterfaceserviec
b、实现类：
采用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
*
升级会员 