Java代码规范浓缩版

Java代码规范浓缩版
规则描述 例子

对类的注释,描述该类的功能.
/*
*Copyright huxin. All rights reserved.
*/
package com.linktone.searcher;
import org.apache.lucene.index.Term;
import org.apache.log4j.Logger;
/**
* 该类的功能描述
* @author YourName
*/
public class A{
}

对类中一个成员变量的注释
public class A {
/**将对number的描述写在这里*/
public int number;
}

对类中一个方法的注释
public class A {
/**
*在这里描述方法的用途。
* @param a 参数a的描述
* @param b 参数b的描述
* @return 返回类型的描述
* @throws Exception 对抛出的异常的描述
*/
public int method1(int a,int b) throws Exception{
}
}

一个类中代码的注释

//注释

a = a+1;

一个带返回值的return语句
不使用小括号"()"，除非它们以
某种方式使返回值更为显见。

return;
return myDisk.size();
return (size ? size : defaultSize);

包命名: 一个唯一包名的前缀总
是全部小写的ASCII字母并且是
一个顶级域名，通常是com，
edu，gov，mil，net，org包名
的后续部分根据不同机构各自内
部的命名规范而不尽相同。

com.sun.eng
com.apple.quicktime.v2
edu.cmu.cs.bovik.cheese

类命名: 类名是个一名词，采用
大小写混合的方式，每个单词的
首字母大写。

class FullTextIndexCreator;

class ImageSprite;

接口: 大小写规则与类名相似,
前面加前缀I
interface IStoring;

抽象类: 大小写规则与类名相
似,前面加前缀 Abs
public abstract class AbsFullTextIndexSearcher
方法: 方法名是一个动词，或者
动词+名词,采用大小写混合的方
式，第一个单词的首字母小写，
其后单词的首字母大写。

public void addElement(Object obj)
public void removeAllElements()
public void write(String str)

常量: 应该全部大写，单词间用下划线隔开。 static final int MIN_WIDTH = 4;
static final int MAX_WIDTH = 999;

避免用一个对象访问一个类的静态变量和方法。应该用类名替代。 AClassName.classMethod(); //OK
anObject.classMethod(); //AVOID!

类中各成员变量的定义总是先于
类中各方法的定义。

public class A{
public int a;
public int b;
public A(){}
public void aMethod(){}
public static void main(String[] args){}
}

类中各成员变量命名顺序：
1． 公共静态成员变量
2． 私有静态成员变量
3． 公共成员变量
4． 保护成员变量
5． 私有成员变量

public class A{
public static final int MIN_WIDTH = 4;
private static final int MIN_WIDTH = 4;
public int a;
protected int b;
private int c;
}

类中各方法出现顺序：
1． 类的构造函数
2． 类的各种方法，按字母
顺序排列
3． 最后才是main函数

public class A{
public A(){
}
public void bMethod(){}
public void fMethod(){}
public void kMethod(){}
public static void main(String[] args){}
}

圆括号(Parentheses)
if (a == b && c == d) // AVOID!
if ((a == b) && (c == d)) // RIGHT

三元运算符" ? : ", 加圆括号
(x >= 0) ? x : -x;