当前位置：首页 > news >正文

「Java基本语法」代码格式与注释规范

news 2025/6/25 20:00:10

Java代码的基本格式

Java代码的规范格式是编写和维护Java程序的基础，其中包括类定义、方法定义、代码缩进、大括号位置等。

1．核心规则

每个Java文件必须包含一个公共类（public class），且Java源文件的文件名必须和这个公共类的类名一致。
Java源文件的后缀名为“.java”。
方法中包含返回类型、方法名、参数列表和代码块。
主方法（main）是Java程序的入口，格式为：

public static void main(String[] args) { ... }

通常使用4个空格或1个Tab键进行缩进，保持代码层次清晰。
左大括号{与语句同行，右大括号}独占一行。

2．示例代码

示例

// 文件名：HelloWorld.java
public class HelloWorld {  // 类名与文件名一致public static void main(String[] args) {  // 主方法System.out.println("Hello, Java!");  // 输出语句}
}

运行结果

Hello, Java!

代码解析

public class HelloWorld：定义公共类，类名是HelloWorld，文件名必须为HelloWorld.java。
public static void main(String[] args)：Java程序的入口方法。
System.out.println("Hello, Java!")：将字符串“Hello, Java!”输出到控制台。

示例：

// 文件名：StudentInfo.java
public class StudentInfo {  // 类名与文件名一致// 定义一个方法，输出学生信息public static void printStudentInfo() {String name = "李华";  // 学生姓名int age = 20;         // 学生年龄String major = "计算机科学"; // 专业System.out.println("姓名: " + name);System.out.println("年龄: " + age);System.out.println("专业: " + major);}public static void main(String[] args) {  // 主方法printStudentInfo();  // 调用方法}
}

运行结果

姓名: 李华
年龄: 20
专业: 计算机科学

代码解析

public class StudentInfo：定义公共类StudentInfo，文件名必须为StudentInfo.java。
public static void printStudentInfo()：定义一个静态方法，用于输出学生信息。
public static void main(String[] args)：程序入口。
printStudentInfo();：在main()方法中调用printStudentInfo方法。

3．常见错误

错误：公共类的类名与文件名不一致，例如，公共类的类名为Test但文件名为Hello.java。

解决方法：确保公共类的类名与文件名完全一致，包括大小写一致。

错误：缺少Java程序的入库main方法导致程序无法运行。

解决方法：确保程序包含public static void main(String[] args)。

错误：大括号位置不规范。

错误示例

public class Test {
public static void main(String[] args)  // 左大括号未换行
{System.out.println("Hello");
}
}

解决方法：左大括号{与语句同行，右大括号}独占一行。

public class Test {public static void main(String[] args) {System.out.println("Hello");}
}

Java中的注释

程序中的注释是用于解释代码逻辑，对代码进行说明，在程序运行时不会起作用。Java中的注释分为单行注释、多行注释和文档注释。

1．注释类型

单行注释：//，从//开始注释到行尾。

// 这是一个单行注释

多行注释：/* */，从/*开始到*/结束，可跨多行进行注释。

/** 这是一个多行注释* 可以跨越多行*/

文档注释：/** */，可以通过javadoc工具用于生成API文档。

/*** 计算两个数的和* @param a 第一个加数* @param b 第二个加数* @return 返回两数之和*/
public static int add(int a, int b) {return a + b;
}

2．示例代码

/*** 这是一个简单的计算器程序* 可以计算加法、减法、乘法和除法* @author Java学习者*/
public class SimpleCalculator {public static void main(String[] args) {int num1 = 15;  // 第一个操作数int num2 = 5;   // 第二个操作数/* 计算并输出结果 */System.out.println("加法结果: " + (num1 + num2));System.out.println("减法结果: " + (num1 - num2));System.out.println("乘法结果: " + (num1 * num2));System.out.println("除法结果: " + (num1 / num2));}
}

运行结果

加法结果: 20
减法结果: 10
乘法结果: 75
除法结果: 3

代码解析

Java源文件保存为“SimpleCalculator.java”。
/** */：文档注释，描述类功能。
//：单行注释，解释变量定义。
/* */：多行注释，注释计算逻辑。

3．常见错误

错误：多行注释未正确闭合。

错误示例：

/* 这是一个未闭合的多行注释
System.out.println("Hello");  // 这行代码会被注释掉

解决方法：确保/*和*/成对出现。

修改后的代码

/* 修改后的多行注释 */
System.out.println("Hello");  // 这行代码会被注释掉

错误：文档注释未放在类或方法前。

错误示例：

public class Test {public static void main(String[] args) {System.out.println("Hello");  // 文档注释不能放在这里/** 错误的文档注释位置 */}
}

解决方法：文档注释需紧跟在类或方法定义之前。

修改后的代码

public class Test {/** 修改后的文档注释位置 */public static void main(String[] args) {System.out.println("Hello");  // 文档注释不能放在这里}
}

知识总结

1．代码格式

公用类的类名必须与文件名一致，公用类中需包含main()方法作为程序的入口。
规范使用缩进和大括号。

2．注释规范

单行注释解释局部逻辑。
多行注释解释复杂逻辑。
文档注释用于生成API文档。

理论练习

选择题：Java程序的入口方法是（）。

A．start() B．main() C．run() D．init()

答案：B

判断题：文档注释可以嵌套在方法内部。（）

答案：错误。文档注释需要放在类或方法的前面。

填空题：Java中，单行注释的符号是________，多行注释的符号是________。

答案：//，/* */

实操练习

练习：编写一个Java程序，输出个人信息（姓名、年龄、爱好）。

要求：

使用文档注释描述类功能。
使用单行注释解释变量定义。

参考答案

/*** 个人信息输出程序*/
public class PersonalInfo {public static void main(String[] args) {String name = "张三";  // 姓名int age = 25;         // 年龄String hobby = "编程"; // 爱好System.out.println("姓名: " + name);System.out.println("年龄: " + age);System.out.println("爱好: " + hobby);}
}

运行结果

姓名: 张三
年龄: 25
爱好: 编程

说明：Java源文件保存为“PersonalInfo.java”。

练习：编写一个Java程序，输出个人信息（姓名、年龄、职业、所在城市）。

要求：

使用文档注释描述类功能。
使用单行注释解释变量定义。

参考答案

/*** 个人信息输出程序*/
public class PersonalInfo {public static void main(String[] args) {String name = "王小明";  // 姓名int age = 28;           // 年龄String occupation = "软件工程师"; // 职业String city = "北京";    // 所在城市System.out.println("姓名: " + name);System.out.println("年龄: " + age);System.out.println("职业: " + occupation);System.out.println("所在城市: " + city);}
}

运行结果

姓名: 王小明
年龄: 28
职业: 软件工程师
所在城市: 北京

说明：Java源文件保存为“PersonalInfo.java”。

练习：编写一个计算矩形面积的程序。

要求：

使用多行注释解释计算逻辑。
输出面积结果。

参考答案

public class RectangleArea {public static void main(String[] args) {int length = 5;  // 长int width = 3;   // 宽/** 计算矩形面积的公式：面积 = 长 × 宽*/int area = length * width;System.out.println("矩形面积: " + area);}
}

运行结果

矩形面积: 15

说明：Java源文件保存为“RectangleArea.java”。

练习：编写一个计算三角形面积的程序。

要求：

使用多行注释解释计算逻辑。
输出面积结果。

参考答案

public class TriangleArea {public static void main(String[] args) {double base = 10.0;    // 底边长度double height = 5.0;   // 高度/** 计算三角形面积的公式：面积 = (底边 × 高度) / 2*/double area = (base * height) / 2;System.out.println("三角形面积: " + area);}
}

运行结果