JAVA命名规范,JAVA命名规范

JAVA命名规范

style=”font-family: Microsoft YaHei”>  关于Java中种种因素的命名,定义那个标准的目的是让项目中颇具的文档都看起来像一个人写的,扩充可读性,缩短项目组中因为换人而带来的损失。(这一个专业并不是肯定要相对遵循,可是一定要让程序有完美的可读性):

  1. Package 的命名

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

  2. Class 的命名
    Class
    的名字务必由大写字母开始而其他字母都小写的单词组成。

  3. Class
    变量的命名

    变量的名字务必用一个小写字母初阶。前边的单词用大写字母开首。

  4. Static Final
    变量的命名

    Static Final
    变量的名字应该都大写,并且提议完整意义。

  5. 参数的命名

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

  6. 数组的命名

    数组应该总是用上边的办法来定名:

    1   byte[] buffer; 
    

    而不是:

    1   byte buffer[];
    
  7. 办法的参数

    利用有含义的参数命名,要是可能的话,使用和要赋值的字段一样的名字:

    1   SetCounter(int size){
    2   this.size = size;
    3   }
    
  8. Java
    文件样式

    所有的 Java(*.java)
    文件都必须信守如下的体裁规则 。
      版权音信必须在 java
    文件的开始,比如:

    1   /**
    2   * Copyright ?0?3 2000 Shanghai XXX Co. Ltd.
    3   * All right reserved.
    4   */ 
    

      其余不须要出现在
    javadoc 的音信也得以涵盖在那里。

  9. Package/Imports
    package 行要在 import
    行之前,import
    中标准的包名要在地头的包名之前,而且依照字母顺序排列。
    若是 import
    行中包蕴了同一个包中的分化子目录,则应当用 * 来处理。

    1   package hotlava.net.stats;
    2   import java.io.*;
    3   import java.util.Observable;
    4   import hotlava.util.Application; 
    

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

  10. Class

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

    1   /**
    2   * A class representing a set of packet and byte counters
    3   * It is observable to allow it to be watched, but only
    4   * reports changes when the current set is complete
    5   */
    
接下来是类定义,包含了在不同的行的 extends 和 implements   
    1   public class CounterSet
    2   extends Observable
    3   implements Cloneable
    4   Class Fields 

 接下来是类的成员变量:

    1   /**
    2   * Packet counters
    3   */
    4   protected int[] packets; 

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

    接下去是类变量的存取的主意。它只是简单的用来将类的变量赋值获取值的话,能够简简单单的写在一行上。

    1   /**
    2   * Get the counters
    3   * @return an array containing the statistical data. This array has been
    4   * freshly allocated and can be modified by the caller.
    5   */
    6   public int[] getPackets() { return copyArray(packets, offset); }
    7   public int[] getBytes() { return copyArray(bytes, offset); }
    8   public int[] getPackets() { return packets; }
    9   public void setPackets(int[] packets) { this.packets = packets; } 
    
其它的方法不要写在一行上
  1. 构造函数

    接下去是构造函数,它应当用递增的方法写(比如:参数多的写在前边)。

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

    1   public
    2   CounterSet(int size){
    3   this.size = size;
    4   }
    
  2. 克隆方法

    一旦那么些类是足以被克隆的,那么下一步就是 clone 方法:

     1   public
     2   Object clone() {
     3   try {
     4   CounterSet obj = (CounterSet)super.clone();
     5   obj.packets = (int[])packets.clone();
     6   obj.size = size;
     7   return obj;
     8   }catch(CloneNotSupportedException e) {
     9   throw new InternalError(“Unexpected CloneNotSUpportedException: ” + e.getMessage());
    10   }
    11   }
    
  3. 类方法
    下边初阶写类的主意:

     1   /**
     2   * Set the packet counters
     3   * (such as when restoring from a database)
     4   */
     5   protected final
     6   void setArray(int[] r1, int[] r2, int[] r3, int[] r4)
     7   throws IllegalArgumentException
     8   {
     9   // Ensure the arrays www.gzlij.com are of equal size
    10 if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)
    11   throw new IllegalArgumentException(“Arrays must be of the same size”);
    12   System.arraycopy(r1, 0, r3, 0, r1.length);
    13   System.arraycopy(r2, 0, r4, 0, r1.length);
    14   }
    
  4. toString
    方法

    不管怎么样,每一个类都应当定义 toString 方法:

     1   public
     2   String toString() {
     3   String retval = “CounterSet: “;
     4   for (int i = 0; i < data.length(); i++) {
     5   retval += data.bytes.toString();
     6   retval += data.packets.toString();
     7   }
     8   return retval;
     9   }
    10   }
    
  5. main 方法
    如果main(String[])
    方法已经定义了, 那么它应当写在类的底部.

JAVA命名规范

style=”font-family: Microsoft YaHei”>  关于Java中各类元素的命名,定义那几个规范的目标是让项目中拥有的文档都看起来像一个人写的,扩张可读性,缩短项目组中因为换人而带来的损失。(那些标准并不是一定要相对遵循,可是一定要让程序有良好的可读性):

  1. Package 的命名

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

  2. Class 的命名
    Class
    的名字务必由大写字母最先而其它字母都小写的单词组成。

  3. Class
    变量的命名

    变量的名字务必用一个小写字母初始。前边的单词用大写字母开始。

  4. Static Final
    变量的命名

    Static Final
    变量的名字应该都大写,并且提议完整意义。

  5. 参数的命名

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

  6. 数组的命名

    数组应该总是用上面的法门来定名:

    1   byte[] buffer; 
    

    而不是:

    1   byte buffer[];
    
  7. 办法的参数

    应用有含义的参数命名,借使可能的话,使用和要赋值的字段一样的名字:

    1   SetCounter(int size){
    2   this.size = size;
    3   }
    
  8. Java
    文件样式

    所有的 Java(*.java)
    文件都必须坚守如下的体裁规则 。
      版权新闻务必在 java
    文件的发端,比如:

    1   /**
    2   * Copyright ?0?3 2000 Shanghai XXX Co. Ltd.
    3   * All right reserved.
    4   */ 
    

      其余不须要出现在
    javadoc 的音信也可以包蕴在那里。

  9. Package/Imports
    package 行要在 import
    行此前,import
    中正式的包名要在当地的包名此前,而且依据字母顺序排列。
    借使 import
    行中包蕴了同一个包中的不相同子目录,则应当用 * 来处理。

    1   package hotlava.net.stats;
    2   import java.io.*;
    3   import java.util.Observable;
    4   import hotlava.util.Application; 
    

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

  10. Class

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

    1   /**
    2   * A class representing a set of packet and byte counters
    3   * It is observable to allow it to be watched, but only
    4   * reports changes when the current set is complete
    5   */
    
接下来是类定义,包含了在不同的行的 extends 和 implements   
    1   public class CounterSet
    2   extends Observable
    3   implements Cloneable
    4   Class Fields 

 接下来是类的成员变量:

    1   /**
    2   * Packet counters
    3   */
    4   protected int[] packets; 

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

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

    1   /**
    2   * Get the counters
    3   * @return an array containing the statistical data. This array has been
    4   * freshly allocated and can be modified by the caller.
    5   */
    6   public int[] getPackets() { return copyArray(packets, offset); }
    7   public int[] getBytes() { return copyArray(bytes, offset); }
    8   public int[] getPackets() { return packets; }
    9   public void setPackets(int[] packets) { this.packets = packets; } 
    
其它的方法不要写在一行上
  1. 构造函数

    接下去是构造函数,它应有用递增的方法写(比如:参数多的写在末端)。

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

    1   public
    2   CounterSet(int size){
    3   this.size = size;
    4   }
    
  2. 仿造方法

    假若这些类是能够被克隆的,那么下一步就是 clone 方法:

     1   public
     2   Object clone() {
     3   try {
     4   CounterSet obj = (CounterSet)super.clone();
     5   obj.packets = (int[])packets.clone();
     6   obj.size = size;
     7   return obj;
     8   }catch(CloneNotSupportedException e) {
     9   throw new InternalError(“Unexpected CloneNotSUpportedException: ” + e.getMessage());
    10   }
    11   }
    
  3. 类方法
    上边起始写类的法门:

     1   /**
     2   * Set the packet counters
     3   * (such as when restoring from a database)
     4   */
     5   protected final
     6   void setArray(int[] r1, int[] r2, int[] r3, int[] r4)
     7   throws IllegalArgumentException
     8   {
     9   // Ensure the arrays www.gzlij.com are of equal size
    10 if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)
    11   throw new IllegalArgumentException(“Arrays must be of the same size”);
    12   System.arraycopy(r1, 0, r3, 0, r1.length);
    13   System.arraycopy(r2, 0, r4, 0, r1.length);
    14   }
    
  4. toString
    方法

    无论怎么着,每一个类都应有定义 toString 方法:

     1   public
     2   String toString() {
     3   String retval = “CounterSet: “;
     4   for (int i = 0; i < data.length(); i++) {
     5   retval += data.bytes.toString();
     6   retval += data.packets.toString();
     7   }
     8   return retval;
     9   }
    10   }
    
  5. main 方法
    如果main(String[])
    方法已经定义了, 那么它应有写在类的尾部.

相关文章