文大师的藏经阁 - 【Java基础】Java代码编写规范及编译运行

Hello,World.

package com.company;

// Main类定义
class Main {
    // main方法，程序的入口点
    public static void main(String[] args) {
        // 打印"Hello, World."到控制台
        System.out.println("Hello, World.");
    }
}

在这段代码中，我们有一个位于顶部的包声明 package com.company;，它表示Main类是com.company包的一部分。

Main类包含了 main 方法，它作为程序的入口点。这个方法会在运行Java程序时被执行。在 main 方法内部，我们有语句 System.out.println("Hello, World.");，它将 “Hello, World.” 打印到控制台。

编译并运行:

C:\Users\VanMek\IdeaProjects\untitled\src\com\company>java Main.java
Hello,World.

C:\Users\VanMek\IdeaProjects\untitled\src\com\company>

如何注释代码

当编写Java注释时，有三种不同的注释类型：单行注释、多行注释和文档注释。下面是每种注释类型的示例和用法：

单行注释：以双斜线 // 开头，用于在一行内添加注释。

// 这是一个单行注释
int x = 10; // 可以在代码后方添加单行注释

多行注释：以斜线星号 /* 开始，以星号斜线 */ 结束，可以跨越多行。

/*
这是一个多行注释。
它可以跨越多行，并且可以包含任意的文本。
*/
int y = 20;

文档注释：以斜线星号 /** 开始，以星号斜线 */ 结束。文档注释通常用于生成API文档。

/**
 * 这是一个文档注释。
 * 它提供了关于类、方法或字段的详细描述。
 */
public class MyClass {
    /**
     * 这是一个文档注释。
     * 它提供了关于方法的详细描述，包括参数、返回值等信息。
     *
     * @param a 参数a的说明
     * @param b 参数b的说明
     * @return 返回值的说明
     */
    public int myMethod(int a, int b) {
        // 方法体
        return a + b;
    }
}

这些是常见的Java注释类型和用法。使用注释可以增加代码的可读性、可维护性和文档化程度。

编码规范

当提及Java的编码规范时，以下是一些常见的编码准则和最佳实践：

命名约定：
- 类名应以大写字母开头，采用驼峰命名法（例如：MyClass）。
- 方法和变量名应以小写字母开头，采用驼峰命名法（例如：myMethod，myVariable）。
- 常量名应全大写，并使用下划线分隔单词（例如：MAX_SIZE）。
缩进和空格：
- 使用四个空格进行代码缩进，而不是制表符。
- 在二元运算符、逗号和分号之前后添加空格，增加代码可读性。
注释：
- 使用注释解释代码的功能、意图和注意事项。
- 在方法、类和接口上使用Javadoc风格的注释，描述其用途、参数和返回值。
- 避免过多或过度注释，注释应精简、清晰且有意义。
代码布局：
- 使用大括号 {} 来定义代码块，左括号与相关语句在同一行，右括号独占一行。
- 每行代码限制为80-120个字符，以保持代码的可读性。
异常处理：
- 捕获异常时，避免使用catch (Exception e)，而是应该具体指定捕获的异常类型。
- 在处理异常时，提供有意义的错误消息和恰当的错误处理逻辑。
其他最佳实践：
- 遵循单一职责原则（SRP），每个类和方法应专注于一个特定的任务或功能。
- 使用合适的数据结构和算法，选择最优的解决方案。
- 编写简洁、可读性强且易于理解的代码。

需要注意的是，不同团队、组织和项目可能会有不同的编码规范。因此，建议您与团队成员讨论并制定适合您项目的具体规范，并在整个团队中保持一致性。此外，许多集成开发环境（IDE）和代码分析工具也提供自动化的代码格式化和规范检查功能，可以帮助您遵循编码规范。

IntelliJ IDEA编码规范

IntelliJ IDEA是一种流行的集成开发环境（IDE），它提供了自己的编码规范和最佳实践。下面是一些常见的IntelliJ IDEA编码规范：

缩进和空格：
- 使用四个空格进行代码缩进，而不是制表符。
- 在二元运算符、逗号和分号之前后添加空格，增加代码可读性。
命名约定：
- 类名应以大写字母开头，采用驼峰命名法（例如：MyClass）。
- 方法和变量名应以小写字母开头，采用驼峰命名法（例如：myMethod，myVariable）。
- 常量名应全大写，并使用下划线分隔单词（例如：MAX_SIZE）。
代码布局：
- 使用大括号 {} 来定义代码块，左括号与相关语句在同一行，右括号独占一行。
- 每行代码限制为80-120个字符，以保持代码的可读性。
注释：
- 使用Javadoc风格的注释来描述类、方法和字段的用途、参数和返回值。
- 使用行注释（//）或块注释（/* ... */）对代码进行必要的解释和说明。
异常处理：
- 捕获异常时，避免使用catch (Exception e)，而是应该具体指定捕获的异常类型。
- 在处理异常时，提供有意义的错误消息和恰当的错误处理逻辑。
自动生成代码：
- 使用IntelliJ IDEA的自动生成代码功能，例如自动导入类、生成getter和setter方法等，以提高编码效率。

IntelliJ IDEA还提供了其他一些功能，如代码格式化、重构工具和代码检查器，可以帮助您遵循编码规范并改善代码质量。

要在IntelliJ IDEA中设置编码规范，您可以访问"Settings/Preferences"（Windows/Linux为Ctrl+Alt+S，Mac为Cmd+,），然后选择"Editor" > “Code Style”。在这里，您可以定义缩进、空格、命名约定等各种代码风格选项，并根据您的偏好进行个性化配置。

下面是一个示例代码，符合IntelliJ IDEA编码规范：

public class MyClass {
    private int myField;

    /**
     * 这是一个示例方法，用于演示代码布局和命名约定。
     *
     * @param value 参数值
     */
    public void myMethod(int value) {
        if (value > 0) {
            myField = value; // 赋值语句后面添加空格
            System.out.println("Value is positive: " + myField); // 拼接字符串时添加空格
        } else {
            System.out.println("Value is non-positive"); // 打印消息
        }
    }
}

在这个示例中，我们遵循了IntelliJ IDEA的编码规范。注意代码缩进、空格的使用，以及变量和方法的命名风格。注释也遵循了Javadoc风格，并对代码进行了必要的解释。

请记住，编码规范是一种约定，团队成员之间应保持一致性。根据您的项目需求和团队偏好，您可以自定义和调整IntelliJ IDEA的编码规范设置。

Java里的保留字

当涉及Java中的保留字时，以下是一些常见的保留字及其用途的示例：

abstract：用于修饰抽象类和抽象方法。抽象类不能被实例化，抽象方法必须在子类中被实现。
assert：用于进行断言检查，用于验证程序的假设条件是否为真。
boolean：表示布尔类型，只能取true或false两个值。
break：用于跳出循环结构（如for、while、do-while）或switch语句。
byte：表示8位有符号整数数据类型。
case：用于在switch语句中匹配不同的条件。
catch：用于捕获并处理异常。
char：表示字符数据类型，用于存储单个字符。
class：用于定义一个类。
const：在早期版本的Java中保留，但目前不再使用。
continue：用于跳过当前循环迭代，进入下一次循环迭代。
default：在switch语句中用作默认情况。
do：用于创建一个执行循环体的循环结构。
double：表示双精度浮点数数据类型。
else：在if语句中表示条件不成立时执行的代码块。
enum：用于定义枚举类型。
extends：在类定义中表示继承另一个类。
final：修饰符，表示无法被继承、修改或重写。
finally：用于在异常处理过程中定义必须被执行的代码块。
float：表示单精度浮点数数据类型。
for：用于创建一个循环结构，控制迭代次数。
goto：在Java中保留，但未使用。
if：用于条件判断，根据条件的真假执行不同的代码块。
implements：在类定义中实现一个接口。
import：用于导入其他包中的类或接口。
instanceof：用于检查对象是否是特定类的实例。
int：表示整数数据类型。
interface：用于定义接口。
long：表示长整数数据类型。
native：用于指示方法是用非Java语言（如C、C++）实现的本地方法。
new：用于创建新的对象实例。
package：用于定义类和接口所属的包。
private：访问修饰符，表示仅在当前类内部可见。
protected：访问修饰符，表示在当前类及其子类、同一包中可见。
public：访问修饰符，表示对所有类可见。
return：用于从方法中返回值。
short：表示短整数数据类型。
static：修饰符，表示静态变量和方法，属于类级别而非实例级别。
strictfp：修饰符，用于确保浮点运算在不同平台上的一致性。
super：用于引用父类的成员或调用父类的构造函数。
switch：用于执行多个分支条件的选择结构。
synchronized：修饰符，用于实现线程同步。
this：表示当前对象的引用。
throw：用于抛出异常。
throws：用于声明方法可能抛出的异常。
transient：修饰符，用于指示

这些保留字在Java语言中有特定的用途和语法含义。因此，您不能将它们用作自定义标识符，如变量名、类名或方法名。

需要注意的是，尽管某些保留字在Java的当前版本中没有特殊的功能，但它们仍然被保留是为了向后兼容性和可能在未来版本中引入新的语法元素。因此，最好避免使用这些保留字作为标识符，以确保代码的可读性和可维护性。