方法的命名规则

方法一般来说都是动词，第一个字母应该小写，在多个单词混合的情况下，第一个单词后的所有单词的第一个字母大写，其余字母小写，例如下面的代码：

run();

runFast();

getBackground();

在方法的声明部分，通常要提供对方法功能的描述，以及方法中返回值与参数的说明，例如下面的代码：

/**

* 显示系统信息方法

* @param message 系统信息参数

* @return message 返回系统信息

*/

public String showMessage (String message) {

…

// statements;

…

return message;

}

如果该方法在软件产品的不断升级中已经不被建议使用了，可以通过在方法声明注释部分添加关键字@deprecated实现。

变量的命名规则

变量的命名规则是，除了变量（variable），所有对象的实例（instance），类（class）与类的常量（constant）的第一个字母应该小写，在多个单词混合的情况下第一个单词后的所有单词的第一个字母大写，其余字母小写的规则之外。变量的第一个字母即使系统允许，也不要为_或者$。变量名字因该紧凑而有意义。变量的名字应该是易记忆、易于理解的，即使间隔较长的时间也可以依其名而知其意。另外单字符的变量名应该尽量避免，除非临时变量，例如，一些整数单字符临时变量：i,j,k,m,n等以及单字符变量：c,d,e等，如下所示的代码：

int i;

char c;

float p_w_picpathWidth;

常量的命名规则

Java中的常量一般采用大写字母单词命名，单词与单词之间用下划线（_）加以分割，这符合ANSI的常量命名规则，如下所示的代码：

static final int MIN_WIDTH = 14;

static final int MAX_WIDTH = 1000;

static final int GET_THE_MEMORY = 128;

常量变量注意事项

a. 用有意义的名字命名变量 首先，用完整的英语单词或约定俗成的简写命名你的变量，如： firstName zipCode 如果英语不够好，至少用别人看得懂的拼音命名，如 zhuZhi (住址） 胡乱简写，或者胡乱命名，则没有人看得懂你的变量的含义： fn zc zz b. 常量用全大写加下画线命名 Java里的常量，就是static final: static final SMTH_BBS="bbs.tsinghua.edu.cn"; c. 用复数命名collection类变量 collection包括数组，vector等。命名时请用复数： customers classMates 也可以用一些修饰词命名： someStudents allDepartments d. 循环变量 一般大家都用i, j, k等做循环变量。 e. Stream变量 一般习惯用in, out作为Stream变量，对应inputStream, outputStream 类。如果即读又写的ioStream，可以用inOut。 f. 变量的命名习惯 习惯MFC的人喜欢采用匈牙利命名法(Hungarian Notation)。如果你习惯这样，尽管用，但注意要和同Project的人保持一致。还有些人习惯C++里的下画线方式，也可以采用。 Hungarian Notation: sFirstName Under Score Style: _firstName 这里提供一个Hungarian Notation的前缀命名习惯： int i byte b char c double d float f long l offset off length len Object o String s (or str) Arbitray value v

Java文件格式 有许多方式定义你的文件语句格式，以下是一个例子： a. 文件头说明 (可无) b. Package定义 c. 空行 d. Import语句 e. 空行 f. 类定义 如： package com.midi; //Java Classes import java.awt.*; import java.io.*; import javax.swing.event.*; //WebLogic Classes import weblogic.internal.*; /** * Blah blah * @author midi * @version 22.2 */ public class MyFirst extends JFrame { ... } /** * Foo... * @author midi * @version 38.2 */ class Foo { ... } import顺序 杂乱无章的顺序，看起来很不顺眼。应该对你要import的classes归类，按顺序罗列： a. Java标准类(java.*) b. Java扩充类(javax.*) c. 第三方类 d. 你的应用程序的类 而且注意在第三方类里注释它们，说明它们的来源： import java.*; import java.util.Date; import java.util.Enumeration; import javax.sql.*; //Apache Xerces import org.apache.xml.*; import org.apache.xerces.dom.*; //Application classes import com.midi.util.*; Classes的顺序 a. Javadoc注释或者其它文件头注释 b. 类声明 c. Fields声明 d. 空行 e. 构造函数 f. 空行 g. 方法（不包括main) h. 空行 i. Inner类 j. 空行 k. main() 例： /** * This is a simple DOM tree XML parser... * ... * @author: midi * @version: 0.0.1 **/ public class MyParser { // public constants public static final String TITLE = "MyParser"; public static final String VERSION = "0.0.1"; // Private variables private int iSchemaVersion; /** * Constructor */ public MyParser () { iSchemaVersion = 1; } /** * Constructor * @param... */ public MyParser (iSchemaVersion) { this.iSchemaVersion = iSchemaVersion; } /** * Initialize the parser... */ public void myInit () throws Exception { .... } /** * start the application */ public static void main (String[] argvs) { ... } } Field定义 请遵从以下顺序： a. Public常量 b. Public变量 c. Protected常量 d. Protected变量 e. Package常量 f. Package变量 g. Private常量 h. Private变量