代码注释与编写规范

Java代码注释与编写规范是Java编程中的重要组成部分,它们有助于提高代码的可读性、可维护性和可重用性。

2.1.1 Java代码注释

代码注释的主要作用是进行代码解释,帮助他人或未来的自己理解代码的功能和目的。在Java源程序文件的任意位置都可添加注释语句,且Java编译器不编译代码中的注释。Java语言提供了3种添加注释的方法,分别是单行注释、多行注释和文档注释。
1.单行注释
“//”为单行注释标记,从符号“//”开始到该行末尾的所有内容都会被编译器忽略,不作为代码执行。常用于对某行代码进行简短说明或标记临时性的更改。语法如下:

//注释内容

例如,以下代码示例为打印“Hello,Java!”到控制台,并为代码加注释。

System.out.println("Hello, World!");      // 这行代码的作用是打印"Hello, World!"到控制台

2.多行注释
多行注释使用“/”开头,注释内容位于中间,以“/”结束。需要注意的是,Java中的多行注释不能嵌套使用,即在一个多行注释内部不能再包含另一个多行注释。语法如下:

/*
注释内容1
注释内容2
...
*/

3.文档注释