java编程规范 参考.doc

java编程规范_参考Java编码规范制定本编程格式的目的是为了使软件可读性好、兼容性好、易维护等等。注:加(*)者为重要保证要求。一、(*)Package的名字应由一个小写单词组成。为了保证包的唯一性,一般以公司国际域名开头。.。(*)Class的名字必须由大写字母开头,并且其它单词的首写字母也要大写。例如:ess。(*)变量/成员属性的名字用一个小写字母开头,后面的单词以大写字母开头。例如:privateStringlastName;(*)Java里的常量,是用staticfinal修饰的,应该用全大写加下划线命名,并且常量名应尽量指出完整含义。如:publicstaticfinalStringORACLE_DB_DRIVER="";:byte[]buffs;而不是:bytebuffs[];,且应使用有意义的参数命名,如果可能的话,使用和要赋值的属性一样的名字,如:setCounter(intsize){=size;}(*)用一个小写字母开头,后面的单词以大写字母开头。应意义明确,对于属性的存取方法,应使用getXXX()和setXXX()名称,以isXXX(),hasXXX()来命名返回值为boolean类型的方法。,用完整的英语单词或约定俗成的简写命名变量,鼓励多用约定俗成的简写命名变量。例如:,包括数组,Vector等。命名时使用复数:例如:ollectioncustomers二、Java源文件样式Java(*.java):packageJavadoc注释或者其它文件头注释类声明Fields声明空行构造函数空行克隆方法空行其它方法(不包括main)空行内部(Inner)类空行main(),例如:/***<p>Title:编码过滤器</p>*<p>Description:</p>*<p>Copyright:Copyright(c)2003</p>*<pany:华软软件学院</p>****@authorweiowen****@*/(*)package行要在版权信息之前,中间空一行。将import的classes归类,按顺序罗列:(java.*)(javax.*)。注意在第三方类里进行注释,说明它们的来源。如果import行中包含了同一个包中的多个类,不推荐用importpakage.*来处理,推荐把要用的类一一import出来。这样程序用到哪些类就可以非常清楚的看出来,有利于代码的维护,增强了代码的可读性。例如:;;;//..*;..*;//.:/***Packetcounters*/protectedint[]packets;public的成员变量必须以生成文档(JavaDoc)的方式进行注释(/**…*/)。protected、private和package定义的成员变量如果名字含义明确的话,可以没有注释。Field定义可遵从以下顺序:(getter,setter)接下来是类成员变量的存取的方法。(*)重载的构造方法应该用递增的方式写(参数多的写在后面)。ounterSet(){this(10);}ounterSet(intsize){=size;},就应实现clone方法:publicObjectclone(){try{CounterSetobj=(Co