java函数命名规范.docx
- 文档编号:27328410
- 上传时间:2023-06-29
- 格式:DOCX
- 页数:11
- 大小:18.88KB
java函数命名规范.docx
《java函数命名规范.docx》由会员分享,可在线阅读,更多相关《java函数命名规范.docx(11页珍藏版)》请在冰豆网上搜索。
java函数命名规范
竭诚为您提供优质文档/双击可除
java函数,命名规范
篇一:
jaVa命名规范
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。
(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)package的命名
package的名字应该都是由一个小写单词组成。
class的命名
class的名字必须由大写字母开头而其他字母都小写的单词组成
class变量的命名
变量的名字必须用一个小写字母开头。
后面的单词用大写字母开头。
staticFinal变量的命名
staticFinal变量的名字应该都大写,并且指出完整含义。
参数的命名
参数的名字必须和变量的命名规范一致。
数组的命名
数组应该总是用下面的方式来命名:
byte[]buffer;
而不是:
bytebuffer[];
方法的参数
使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:
setcounter(intsize){
this.size=size;
}
java文件样式
所有的java(*.java)文件都必须遵守如下的样式规则
版权信息
版权信息必须在java文件的开头,比如:
/**
*copyright032000shanghaixxxco.ltd.
*allrightreserved.
*/
其他不需要出现在javadoc的信息也可以包含在这里。
package/imports
package行要在import行之前,import中标准的包名要在本地的包名之前,而且按照字母顺序排列。
如果import行中包含了同一个包中的不同子目录,则应该用*来处理。
.stats;
importjava.io.*;
importjava.util.observable;
importhotlava.util.application;
这里java.io.*使用来代替inputstreamandoutputstream的。
class
接下来的是类的注释,一般是用来解释类的。
/**
*aclassrepresentingasetofpacketandbytecounters
*itisobservabletoallowittobewatched,butonly
*reportschangeswhenthecurrentsetiscomplete
*/
接下来是类定义,包含了在不同的行的extends和implements
publicclasscounterset
extendsobservable
implementscloneable
classFields
接下来是类的成员变量:
/**
*packetcounters
*/
protectedint[]packets;
public的成员变量必须生成文档(javadoc)。
proceted、private和package定义的成员变量如果名字含义明确的话,可以没有注释。
存取方法
接下来是类变量的存取的方法。
它只是简单的用来将类的变量赋值获取值的话,可以简单的
写在一行上。
/**
*getthecounters
*@returnanarraycontainingthestatisticaldata.thisarrayhasbeen*freshlyallocatedandcanbemodifiedbythecaller.
*/
publicint[]getpackets(){returncopyarray(packets,offset);}
publicint[]getbytes(){returncopyarray(bytes,offset);}
publicint[]getpackets(){returnpackets;}
publicvoidsetpackets(int[]packets){this.packets=packets;}
其它的方法不要写在一行上
构造函数
接下来是构造函数,它应该用递增的方式写(比如:
参数多的写在后面)。
访问类型("public","private"等.)和任何"static","final"或"synchronized"应该在一行中,并且方法和参数另写一行,这样可以使方法和参数更易读。
public
counterset(intsize){
this.size=size;
}
克隆方法
如果这个类是可以被克隆的,那么下一步就是clone方法:
public
objectclone(){
try{
countersetobj=(counterset)super.clone();
obj.packets=(int[])packets.clone();
obj.size=size;
returnobj;
}catch(clonenotsupportedexceptione){
thrownewinternalerror("unexpectedclonenotsupportedexception:
"+e.getmessage());
}
}
类方法
下面开始写类的方法:
/**
*setthepacketcounters
*(suchaswhenrestoringfromadatabase)
*/
protectedfinal
voidsetarray(int[]r1,int[]r2,int[]r3,int[]r4)
throwsillegalargumentexception
{
//
//ensurethearraysareofequalsize
//
if(r1.length!
=r2.length||r1.length!
=r3.length||r1.length!
=r4.length)thrownewillegalargumentexception("arraysmustbeofthesamesize");system.arraycopy(r1,0,r3,0,r1.length);
system.arraycopy(r2,0,r4,0,r1.length);
}
tostring方法
无论如何,每一个类都应该定义tostring方法:
public
stringtostring(){
stringretval="counterset:
";
for(inti=0;i retval+=data.bytes.tostring();
retval+=data.packets.tostring();
}
returnretval;
}
}
main方法
如果main(string[])方法已经定义了,那么它应该写在类的底部.
代码编写格式
代码样式
代码应该用unix的格式,而不是windows的(比如:
回车变成回车+换行)
文档化
必须用javadoc来为类生成文档。
不仅因为它是标准,这也是被各种java编译器都认可的方法。
使用@author标记是不被推荐的,因为代码不应该是被个人拥有的。
缩进
缩进应该是每行2个空格.不要在源文件中保存tab字符.在使用不同的源代码管理工具时tab字符将因为用户设置的不同而扩展为不同的宽度.
如果你使用ultredit作为你的java源代码编辑器的话,你可以通过如下操作来禁止保存tab字符,方法是通过ultredit中先设定tab使用的长度室2个空格,然后用Format|tabstospaces菜单将tab转换为空格。
页宽
页宽应该设置为80字符.源代码一般不会超过这个宽度,并导致无法完整显示,但这一设置也可以灵活调整.在任何情况下,超长的语句应该在一个逗号或者一个操作符后折行.一条语句折行后,应该比原来的语句再缩进2个字符.
{}对
{}中的语句应该单独作为一行.例如,下面的第1行是错误的,第2行是正确的:
if(i>0){i++};//错误,{和}在同一行
if(i>0){
i++
};//正确,{单独作为一行
}语句永远单独作为一行.
如果}语句应该缩进到与其相对应的{那一行相对齐的位置。
括号
左括号和后一个字符之间不应该出现空格,同样,右括号和前一个字符之间也不应该出现空格.下面的例子说明括号和空格的错误及正确使用:
callproc(aparameter);//错误
callproc(aparameter);//正确
不要在语句中使用无意义的括号.括号只应该为达到某种目的而出现在源代码中。
下面的例子说明错误和正确的用法:
if((i)=42){//错误-括号毫无意义
if(i==42)or(j==42)then//正确-的确需要括号
篇二:
java命名规则详细总结
1.jaVa源文件的命名jaVa源文件名必须和源文件中所定义的类的类名相同。
2.package的命名package名的第一部分应是小写ascii字符,并且是顶级域名之一,通常是com、edu、gov、mil、net、org或由iso标准3166、1981定义的国家唯一标志码。
package名的后续部分由各组织内部命名规则决定,内部命名规则指定了各组件的目录名,所属部门名、项目名等。
3.class/interface的命名class名应是首字母大写的名词。
命名时应该使其简洁而又具有描述性。
异常类的命名,应以exception结尾。
interface的命名规则与class相同。
4.常量的命名常量名的字母应全部大写,不同的单词之间通过下划线进行连接,并且名字组合应该赋予含义。
5.变量的命名
5.1普通变量普通变量名的首字母小写,其它每个单词的首字母大写。
命名时应该使其简短而又有特定含义,简洁明了的向使用者展示其使用意图。
5.2约定变量所谓约定变量,是指那些使用后即可抛弃
(throwaway)的临时变量。
通常i、j、k、m和n代表整型变量;c、d和e代表字符型变量。
6.方法的命名方法名的第一个单词应是动词,并且首字母小写,其它每个单词首字母大写。
7.方法参数的命名应该选择有意义的名称作为方法的参数名。
如果可能的话,选择和需要赋值的字段一样的名字。
补充资料:
1、类名首字母应该大写。
属性(成员变量)、方法、对象变量以及所有标识符(如形式参数、实际参数、局部变量)的首字母应小写,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。
例如:
类名:
thisisaclassname属性或方法名:
thisismethodorFieldname对象变量:
thisisaclassVariable
2、java包(package)属于一种特殊情况,它们全都是小写字母,即便中间的单词亦是如此。
对于全局包,将你的internet域名反转并接上包名。
例如:
cn.edu.usst.dingyuewei.package。
另外,package行要在import行之前,import中标准的包名要在本地的包名之前,而且按照字母顺序排列。
如果import行中包含了同一个包中的不同子目录,则应该用*来处理。
例如:
.stats;
importjava.io.*;
importjava.util.observable;
importhotlava.util.application;
这里java.io.*是用来代替inputstreamandoutputstream的。
3、接口(interface):
采用完整的英文描述符说明接口封装,所有单词的第一个字母大写。
习惯上,名字后面加上后缀able,ible或者er。
例如:
contactable,prompter。
4、组件(component)使用完整的英文描述来说明组件的用途,末端应接上组件类型。
例如:
okbutton,customerlist,filemenu。
5、类中常用方法的命名:
a)类的获取方法(一般具有返回值)一般要求被方法名使用被访问字段名,前面加上前缀get,例如getFirstname(),getlastname()。
b)类的布尔型的判断方法一般要求方法名使用单词is做前缀,如ispersistent(),isstring()。
或者使用具有逻辑意义的单词,例如equal或equals
c)类的设置方法(一般返回类型为void):
被访问字段名的前面加上前缀set,例如setFirstname(),setlastname(),setwarpspeed()d)类的普通方法一般采用完整的英文描述说明成员方法功能,第一个单词尽可能采用一个生动的动词,第一个字母小写,例如openFile(),addaccount()。
e)构造方法应该用递增的方式写(比如:
参数多的写在后面)。
例如:
publiccounterset(){}
publiccounterset(intsize){this.size=size;}
f)tostring方法:
一般情况下,每一个类都应该定义tostring方法,其格式为:
publicstringtostring(){…}
g)一般应考虑置入一个main()方法,其中包含用于测试那个类的代码,如果包含了main()方法,那么它应该写在类的底部。
6、静态常量字段(staticfinal)一般全部采用大写字母,单词之间用下划线分隔(也有特例,如java类库中关于颜色的常数没有严格地全部使用大写字母)。
例如min_balance,deFault_date。
7、循环计数变量通常采用字母i,j,k或者counter。
而数组应该总是用下面的方式来命名:
objecttype[]或byte[]buffer。
篇三:
java编程命名规范
java编程命名规范
命名规范
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。
(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)
package的命名
package的名字应该都是由一个小写单词组成。
class的命名
(java函数,命名规范) class的名字必须由大写字母开头而其他字母都小写的单词组成
class变量的命名
变量的名字必须用一个小写字母开头。
后面的单词用大写字母开头。
staticFinal变量的命名
staticFinal变量的名字应该都大写,并且指出完整含义。
参数的命名
参数的名字必须和变量的命名规范一致。
数组的命名
数组应该总是用下面的方式来命名:
byte[]buffer;而不是:
bytebuffer[];
方法的参数
使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:
setcounter(intsize){
this.size=size;
}
java文件样式
所有的java(*.java)文件都必须遵守如下的样式规则
版权信息
版权信息必须在java文件的开头,比如:
/**
*copyright2000shanghaixxxco.ltd.
*allrightreserved.
*/
其他不需要出现在javadoc的信息也可以包含在这里。
package/imports
package行要在import行之前,import中标准的包名要在本地的包名之前,而且按照字母顺序排列。
如果import行中包含了同一个包中的不同子目录,则应该用*来处理。
.stats;
importjava.io.*;
importjava.util.observable;
importhotlava.util.application;
这里java.io.*使用来代替inputstreamandoutputstream的。
class
接下来的是类的注释,一般是用来解释类的。
/**
*aclassrepresentingasetofpacketandbytecounters
*itisobservabletoallowittobewatched,butonly
*reportschangeswhenthecurrentsetiscomplete
*/
接下来是类定义,包含了在不同的行的extends和implements
publicclasscounterset
extendsobservable
implementscloneable
classFields
接下来是类的成员变量:
/**
*packetcounters
*/
protectedint[]packets;
public的成员变量必须生成文档(javadoc)。
proceted、private和package定义的成员变量如果名字含义明确的话,可以没有注释。
存取方法
接下来是类变量的存取的方法。
它只是简单的用来将类的变量赋值获取值的话,可以简单的写在一行上。
/**
*getthecounters
*@returnanarraycontainingthestatisticaldata.thisarrayhasbeen
*freshlyallocatedandcanbemodifiedbythecaller.
*/
publicint[]getpackets(){returncopyarray(packets,offset);}
publicint[]getbytes(){returncopyarray(bytes,offset);}
publicint[]getpackets(){returnpackets;}
publicvoidsetpackets(int[]packets){this.packets=packets;}
其它的方法不要写在一行上
构造函数
接下来是构造函数,它应该用递增的方式写(比如:
参数多的写在后面)。
访问类型("public","private"等.)和任何"static","final"或
"synchronized"应该在一行中,并且方法和参数另写一行,这样可以使方法和参数更易读。
public
counterset(intsize){
this.size=size;
}
克隆方法
如果这个类是可以被克隆的,那么下一步就是clone方法:
public
objectclone(){
try{
countersetbj=(counterset)super.clone();
obj.packets=(int[])packets.clone();
obj.size=size;
returnobj;
}catch(clonenotsupportedexceptione){
thrownewinternalerror("unexpectedclonenotsupportedexception:
"+e.getmessage());
}
}
类方法
下面开始写类的方法:
/**
*setthepacketcounters
*(suchaswhenrestoringfromadatabase)
*/
protectedfinal
voidsetarray(int[]r1,int[]r2,int[]r3,int[]r4)
throwsillegalargumentexception
{
//
//ensurethearraysareofequalsize
//
if(r1.length!
=r2.length||r1.length!
=r3.length||r1.length!
=r4.length)
thrownewillegalargumentexception("arraysmustbeofthesamesize");
system.arraycopy(r1,0,r3,0,r1.length);
system.arraycopy(r2,0,r4,0,r1.length);
}
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- java 函数 命名 规范