java函数命名规范.pdf
竭诚为您提供优质文档/双击可除
java函数,命名规范
篇一:jaVa命名规范
定义这个规范的目的是让项目中所有的文档都看起来
像一个人写的,增加可读性,减少项目组中因为换人而带来
的损失。(这些规范并不是一定要绝对遵守,但是一定要让
程序有良好的可读性)package的命名
package的名字应该都是由一个小写单词组成。
class的命名
class的名字必须由大写字母开头而其他字母都小写的
单词组成
class变量的命名
变量的名字必须用一个小写字母开头。后面的单词用大
写字母开头。
staticFinal变量的命名
staticFinal变量的名字应该都大写,并且指出完整
义。
参数的命名
参数的名字必须和变量的命名规范一致。
第1页共19页
数组的命名
数组应该总是用下面的方式来命名:
byte[]buffer;
而不是:
bytebuffer[];
方法的参数
使用有意义的参数命名,如果可能的话,使用和要赋值
的字段一样的名字:
setcounter(intsize){
this.size=size;
}
java文件样式
所有的java(*.java)文件都必须遵守如下的样式规则
版权信息
版权信息必须在java文件的开头,比:
/**
*copyright032000shanghaixxxco.ltd.
*allrightreserved.
*/
其他不需要出现在javadoc的信息也可以包含在这里。
package/imports
package行要在import行之前,import中标准的包名
第2页共19页
要在本地的包名之前,而且按照字母顺序排列。如果import
行中包含了同一个包中的不同子目录,则应该用*来处理。
packagehotlava.net.stats;
importjava.io.*;
importjava.util.observable;
importhotlava.util.application;
这里java.io.*使用来代替
inputstreamandoutputstream的。
class
接下来的是类的注释,一般是用来解释类的。
/**
*aclassrepresentingasetofpacketandbytecounters
*itisobservabletoallowittobewatched,butonly
*reportschangeswhenthecurrentsetiscomplete
*/
接下来是类定义,包含了在不同的行的extends和
implements
publicclasscounterset
extendsobservable
implementscloneable
classFields
接下来是类的成员变量:
第3页共19页
/**
*packetcounters
*/
protectedint[]packets;
public的成员变量必须生成文档(javadoc)。proceted、
private和package定义的成员变量如果名字含义明确的话,
可以没有注释。
存取方法
接下来是类变量的存取的方法。它只是简单的用来将类
的变量赋值获取值的话,可以简单的
写在一行上。