2017.10.6 Java命名规范及使用情况

 

  1. Package 的命名

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

    Class 的命名

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

    Class 变量的命名

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

    Static Final 变量的命名

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

  2. 参数的命名

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

    数组的命名

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

      byte[] buffer;

      而不是:

      byte buffer[];

    方法的参数

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

      SetCounter(int size){

      this.size = size;

      }

  3. Java 文件样式

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

    版权信息

      版权信息必须在 java 文件的开头,比如:

      /**

      * Copyright ?0?3 2000 Shanghai XXX Co. Ltd.

      * All right reserved.

      */

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

  4. 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 的。

  5. Class

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

      /**

      * A class representing a set of packet and byte counters

      * It is observable to allow it to be watched, but only

      * reports changes when the current set is complete

      */

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

      public class CounterSet

      extends Observable

      implements Cloneable

      Class Fields

      接下来是类的成员变量:

      /**

      * Packet counters

      */

      protected int[] packets;

      public 的成员变量必须生成文档(JavaDoc)。proceted、private和 package 定义的成员变量如果名字含义明确的话,可以没有注释。

  6. 存取方法

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

      /**

      * Get the counters

      * @return an array containing the statistical data. This array has been

      * 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; }

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

  7. 构造函数

      接下来是构造函数,它应该用递增的方式写(比如:参数多的写在后面)。

    访问类型 ("public", "private" 等.) 和 任何 "static", "final" 或 "synchronized" 应该在一行中,并且方法和参数另写一行,这样可以使方法和参数更易读。

      public

      CounterSet(int size){

      this.size = size;

      }

    克隆方法

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

      public

      Object clone() {

      try {

      CounterSet obj = (CounterSet)super.clone();

      obj.packets = (int[])packets.clone();

      obj.size = size;

      return obj;

      }catch(CloneNotSupportedException e) {

      throw new InternalError("Unexpected CloneNotSUpportedException: " + e.getMessage());

      }

      }

  8. 类方法

      下面开始写类的方法:

      /**

      * 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 www.gzlij.com are of equal size

    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);

      }

  9. toString 方法

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

      public

      String toString() {

      String retval = "CounterSet: ";

      for (int i = 0; i < data.length(); i++) {

      retval += data.bytes.toString();

      retval += data.packets.toString();

      }

      return retval;

      }

      }

    main 方法

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

     

    5、类中常用方法的命名:  

    a)类的获取方法(一般具有返回值)一般要求被方法名使用被访问字段名,前面加上前缀get,例如getFirstName(), getLastName()。  

    b)类的布尔型的判断方法一般要求方法名使用单词 is 做前缀,如isPersistent(),isString()。或者使用具有逻辑意义的单词,例如equal 或equals  

    c)类的设置方法(一般返回类型为void):被访问字段名的前面加上前缀 set,例如setFirstName(),setLastName(),setWarpSpeed()  

    d)类的普通方法一般采用完整的英文描述说明成员方法功能,第一个单词尽可能采用一个生动的动词,第一个字母小写,例如 openFile(), addAccount()。  

    e)构造方法应该用递增的方式写(比如:参数多的写在后面)。例如:  public CounterSet(){}  public CounterSet(int size){ this.size = size;}  

    f)toString 方法:一般情况下,每一个类都应该定义toString 方法,其格式为:public String toString() {…}  

    g)一般应考虑置入一个main()方法,其中包含用于测试那个类的代码,如果包含了main() 方法, 那么它应该写在类的底部。  

     

    6、静态常量字段(static final)一般全部采用大写字母,单词之间用下划线分隔(也有特例,如Java 类库中关于颜色的常数没有严格地全部使用大写字母)。例如MIN_BALANCE,DEFAULT_DATE。   7、循环计数变量通常采用字母 i,j,k 或者 counter。而数组应该总是用下面的方式来命名:objectType[]或 byte[] buffer。

posted @ 2017-10-06 22:39  LegendQi  阅读(187)  评论(0编辑  收藏  举报