解释类的 Java 编码标准

简介

本文将介绍 Java 编码中关于类（class）的标准。它包括类的命名规则、类的文件命名规则、类的注释、类的结构等。

类的命名规则

类名应该使用大写字母开头的驼峰命名法（camelCase）。类名应该是名词或名词短语，应该具有描述性和表达力，以便于理解它的作用。类名应该避免缩写和缩写。

例如，一个表示猫的类应该被命名为Cat而不是CT或c。

类的文件命名规则

文件名应该与类名相同，用camelCase命名法，但第一个字母应该是小写的。例如，对于一个表示猫的类，文件名应该是cat.java。

类的注释

类应该有一个简要的描述，解释其作用，并提供它的输入和输出。这个描述应该放在类的开头，使用注释（//）。

JavaDoc 风格的文档应该用于类、方法和变量的注释。每个类、方法和变量都应该有一个注释，可以用工具自动生成文档。

例如，

/**
* A class representing a Cat
* Takes in the name of the cat as string and its age as integer
* Outputs the sound of the cat as a string
*/
public class Cat{
// class content here
}

类的结构

类的结构应该是清晰的、有组织的，以便于理解和修改。通常，一个类应该包括以下组成部分：

1. 注释
2. 常量
3. 字段
4. 构造函数
5. 普通方法

注释

如前所述，应该在类开头写一个类注释。

常量

如果一个类包含一些常量（如枚举值或固定值），则应该将它们定义为静态 final 常量。

public class Cat{
  /**
  * The sound "Meow"
  */
  public static final String SOUND = "Meow";
  
  // class content here
}

字段

类的字段应该是私有的，并且只能通过 getter 和 setter 方法进行访问。

每个字段应该有一个清晰的用途，并且应该有注释。

public class Cat{
  private String name;
  private int age;
  
  /**
  * Sets the name of the cat
  * @param name - a String input
  */
  public void setName(String name){
    this.name = name;
  }
  
  /**
  * Returns the name of the cat
  * @return a String
  */
  public String getName(){
    return name;
  }
  
  /**
  * Sets the age of the cat
  * @param age - an integer input
  */
  public void setAge(int age){
    this.age = age;
  }
  
  /**
  * Returns the age of the cat
  * @return an integer
  */
  public int getAge(){
    return age;
  }
  
  // class content here
}

构造函数

一个类应该定义一个或多个构造函数。如果没有定义构造函数，则将使用默认构造函数。

构造函数应该按照以下结构编写：

public class Cat{
  private String name;
  private int age;
  
  /**
  * Default constructor, creates a Cat object with no parameters
  */
  public Cat(){
    // constructor content here
  }
  
  /**
  * Constructs a Cat object with a name and age parameter
  * @param name - a String input
  * @param age - an integer input
  */
  public Cat(String name, int age){
    this.name = name;
    this.age = age;
  }
  
  // class content here
}

普通方法

最后，一个类应该包含一些方法来完成它的任务。这些方法应该有清晰的名称和注释。

方法应该按照以下结构编写：

public class Cat{
  private String name;
  private int age;
  
  // constructor here
  
  /**
  * Returns the sound of the cat
  * @return a String
  */
  public String makeSound(){
    return "Meow";
  }
  
  // class content here
}

结论

规范的编码标准是优秀软件开发的一个必要元素。在编写 Java 代码时，特别是在编写类时，应该遵循上述规则，以便其他程序员可以更容易地理解和修改您的代码。