JAVA编程规范技巧

最新推荐文章于 2024-09-14 18:46:05 发布

jiazhengjing

最新推荐文章于 2024-09-14 18:46:05 发布

阅读量373

点赞数

分类专栏： java转载文章标签： java 编程 javadoc swing string import

java转载专栏收录该内容

5 篇文章 0 订阅

订阅专栏

JAVA编程规范

命名规范

定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组

中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可

读性）

Package的命名

Package的名字应该都是由一个小写单词组成。

Class的命名

Class的名字必须由大写字母开头而其他字母都小写的单词组成

Class变量的命名

变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。

Static Final变量的命名

Static Final变量的名字应该都大写，并且指出完整含义。

参数的命名

参数的名字必须和变量的命名规范一致。

数组的命名

数组应该总是用下面的方式来命名：

byte[]buffer;

而不是：

byte buffer[];

方法的参数

使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：

SetCounter(intsize){

this.size=size;

}

Java文件样式

所有的Java(*.java)文件都必须遵守如下的样式规则

版权信息

版权信息必须在java文件的开头，比如：

/**
*Copyright®2000ShanghaiXXXCo.Ltd.
*Allrightreserved.
*/

其他不需要出现在javadoc的信息也可以包含在这里。

Package/Imports

package行要在import行之前，import中标准的包名要在本地的包名之前，而且按照字母顺序

排列。如果import行中包含了同一个包中的不同子目录，则应该用*来处理。

package hotlava.net.stats;
import java.io.*;
import java.util.Observable;
import hotlava.util.Application;

这里java.io.*使用来代替InputStream and OutputStream的。

Class

接下来的是类的注释，一般是用来解释类的。

/**
*Aclassrepresentingasetofpacketandbytecounters
*Itisobservabletoallowittobewatched,butonly
*reportschangeswhenthecurrentsetiscomplete
*/

接下来是类定义，包含了在不同的行的extends和implements

publicclassCounterSet
extendsObservable
implementsCloneable
ClassFields

接下来是类的成员变量：

/**
*Packetcounters
*/ protectedint[]packets;

public的成员变量必须生成文档（JavaDoc）。proceted、private和package定义的成员变量

如果名字含义明确的话，可以没有注释。

存取方法

接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的写

在一行上。

/**
*Get the counters
*@return a narray containing the statisticaldata.Thisarrayhasbeen
*freshly allocated and can be modified by the caller.
*/
public int[]getPackets(){return copyArray(packets,offset);}
public int[]getBytes(){return copyArray(bytes,offset);}
public int[]getPackets(){return packets;}
public void setPackets(int[]packets){this.packets=packets;}

其它的方法不要写在一行上

构造函数

接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。

访问类型("public","private"等.)和任何"static","final"或"synchronized"应该在一行中

，并且方法和参数另写一行，这样可以使方法和参数更易读。

public CounterSet(intsize){
this.size=size;
}

克隆方法

如果这个类是可以被克隆的，那么下一步就是clone方法：

public Object clone(){
try{
    Counter Setobj=(CounterSet)super.clone();
    obj.packets=(int[])packets.clone();
    obj.size=size;
    return obj;
}catch(CloneNotSupportedException e){
    throw new InternalError("Unexpected CloneNotSUpportedException:"+e.getMessage

());
}
}

类方法

下面开始写类的方法：

/**
*Set the packet counters
*(such as when restoring from a database)
*/
protected final void setArray(int[]r1,int[]r2,int[]r3,int[]r4) throws

IllegalArgumentException{
//
//Ensure the arrays are of equalsize
//
if(r1.length!=r2.length||r1.length!=r3.length||r1.length!=r4.length)
throw new IllegalArgumentException("Arrays must be of the same size");
System.arraycopy(r1,0,r3,0,r1.length);
System.arraycopy(r2,0,r4,0,r1.length);
}

toString方法

无论如何，每一个类都应该定义toString方法：

public String toString(){
String retval="CounterSet:";
for(inti=0;iretval+=data.bytes.toString();
retval+=data.packets.toString();
}
return retval;
}
}

main方法

如果main(String[])方法已经定义了,那么它应该写在类的底部.

代码编写格式

代码样式

代码应该用unix的格式，而不是windows的（比如：回车变成回车+换行）

文档化

必须用javadoc来为类生成文档。不仅因为它是标准，这也是被各种java编译器都认可的方法

。使用@author标记是不被推荐的，因为代码不应该是被个人拥有的。

缩进

缩进应该是每行2个空格.不要在源文件中保存Tab字符.在使用不同的源代码管理工具时Tab字

符将因为用户设置的不同而扩展为不同的宽度.

如果你使用UltrEdit作为你的Java源代码编辑器的话，你可以通过如下操作来禁止保存Tab字

符,方法是通过UltrEdit中先设定Tab使用的长度室2个空格，然后用Format|Tabs to Spaces菜

单将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//正确-的确需要括号

程序编写规范

exit()

exit除了在main中可以被调用外，其他的地方不应该调用。因为这样做不给任何代码代码机会

来截获退出。一个类似后台服务地程序不应该因为某一个库模块决定了要退出就退出。

异常

申明的错误应该抛出一个RuntimeException或者派生的异常。

顶层的main()函数应该截获所有的异常，并且打印（或者记录在日志中）在屏幕上。

垃圾收集

JAVA使用成熟的后台垃圾收集技术来代替引用计数。但是这样会导致一个问题：你必须在使用

完对象的实例以后进行清场工作。比如一个prel的程序员可能这么写：

...
{
FileOutputStream fos=new FileOutputStream(projectFile);
project.save(fos,"IDEProjectFile");
}
...

除非输出流一出作用域就关闭，非引用计数的程序语言，比如JAVA，是不能自动完成变量的清

场工作的。必须象下面一样写：

FileOutputStream fos=new FileOutputStream(projectFile);
project.save(fos,"IDEProjectFile");
fos.close();
Clone

下面是一种有用的方法：

implements Cloneable
public Objectclone(){
try{
    ThisClass obj=(ThisClass)super.clone();
    obj.field1=(int[])field1.clone();
    obj.field2=field2;
    return obj;
}catch(CloneNotSupportedException e){
    throw new InternalError("Unexpected CloneNotSUpportedException:"+e.getMessage

());
}
}

final类

绝对不要因为性能的原因将类定义为final的（除非程序的框架要求）

如果一个类还没有准备好被继承，最好在类文档中注明，而不要将她定义为final的。这是因

为没有人可以保证会不会由于什么原因需要继承她。

访问类的成员变量

大部分的类成员变量应该定义为protected的来防止继承类使用他们。

注意，要用"int[]packets"，而不是"int packets[]"，后一种永远也不要用。

public void setPackets(int[]packets){
this.packets=packets;
}
CounterSet(intsize)
{
this.size=size;
}

编程技巧

byte数组转换到characters

为了将byte数组转换到characters，你可以这么做：

"Helloworld!".getBytes();

Utility类

Utility类（仅仅提供方法的类）应该被申明为抽象的来防止被继承或被初始化。

初始化

下面的代码是一种很好的初始化数组的方法：

object Arguments=new Object[]{arguments};

枚举类型

JAVA对枚举的支持不好，但是下面的代码是一种很有用的模板：

class Colour{
public static final ColourBLACK=newColour(0,0,0);
public static final ColourRED=newColour(0xFF,0,0);
public static final ColourGREEN=newColour(0,0xFF,0);
public static final ColourBLUE=newColour(0,0,0xFF);
public static final ColourWHITE=newColour(0xFF,0xFF,0xFF);
}

这种技术实现了RED,GREEN,BLUE等可以象其他语言的枚举类型一样使用的常量。他们可以用==

操作符来比较。

但是这样使用有一个缺陷：如果一个用户用这样的方法来创建颜色BLACK

newColour(0,0,0)

那么这就是另外一个对象，==操作符就会产生错误。她的equal()方法仍然有效。由于这个原

因，这个技术的缺陷最好注明在文档中，或者只在自己的包中使用。

Swing

避免使用AWT组件

混合使用AWT和Swing组件

如果要将AWT组件和Swing组件混合起来使用的话，请小心使用。实际上，尽量不要将他们混合

起来使用。

滚动的AWT组件