Java 源文件的声明有一些规则,这些规则确保了代码的组织性和可读性。以下是 Java 源文件的一些基本声明规则:
-
文件命名:
- 源文件的名字应该和公共类(public class)的名字完全一致,包括大小写,并且以
.java
为扩展名。例如,如果有一个公共类名为Employee
,那么源文件应该命名为Employee.java
。
- 源文件的名字应该和公共类(public class)的名字完全一致,包括大小写,并且以
-
包声明:
- 如果需要将类放在一个特定的包中,那么必须在文件的最开始使用
package
关键字来声明这个包。包声明是可选的,但是一旦使用,它必须是文件中的第一条语句。 - 包声明之后通常会有一个空行。
- 例如:
package com.example;
- 如果需要将类放在一个特定的包中,那么必须在文件的最开始使用
-
导入声明:
- 在包声明之后(如果有包声明的话),可以使用
import
关键字来导入其他包中的类或接口。 - 导入语句可以有多个,每个导入语句占一行。
- 可以使用通配符
*
来导入一个包下的所有类,但通常推荐显式地导入所需的类。 - 例如:
import java.util.ArrayList;
或import java.util.*;
- 在包声明之后(如果有包声明的话),可以使用
-
类和接口声明:
- 源文件中可以包含多个类和接口,但是只能有一个公共类(public class)。
- 如果源文件中包含一个公共类,那么该公共类的名字必须与文件名相同。
- 非公共类和接口可以有任意数量,它们的名字不必与文件名相同。
- 类和接口之间可以有空行来分隔,增加可读性。
-
主方法:
- 如果源文件需要作为一个可执行程序运行,那么至少要有一个类包含
main
方法。 main
方法的签名必须是public static void main(String[] args)
。
- 如果源文件需要作为一个可执行程序运行,那么至少要有一个类包含
-
注释:
- 可以在源文件中添加注释来描述代码的功能、作者信息等。
- 单行注释使用
//
开头,多行注释使用/* ... */
包围,文档注释使用/** ... */
包围。
-
编码风格:
- 虽然不是强制性的,但遵循一定的编码风格对于保持代码的一致性和可维护性非常重要。这包括缩进、括号的使用、变量命名等。
下面是一个符合上述规则的简单示例:
// 文件名: HelloWorld.java
package com.example;
import java.util.*;
/**
* 这是一个简单的 Hello World 程序。
*/
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
在这个例子中,HelloWorld
是公共类,因此文件名必须是 HelloWorld.java
。此外,还包含了包声明和一条打印输出的 main
方法。
总结:
- 一个源文件中只能有一个 public 类
- 一个源文件可以有多个非 public 类
- 源文件的名称应该和 public 类的类名保持一致。例如:源文件中 public 类的类名是 Employee,那么源文件应该命名为Employee.java。
- 如果一个类定义在某个包中,那么 package 语句应该在源文件的首行。
- 如果源文件包含 import 语句,那么应该放在 package 语句和类定义之间。如果没有 package 语句,那么 import 语句应该在源文件中最前面。
- import 语句和 package 语句对源文件中定义的所有类都有效。在同一源文件中,不能给不同的类不同的包声明。