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[])
    方法已经定义了, 那么它应该写在类的尾部.

相关文章