Java代码注释与编码规范

目录

一、代码注释

1.单行注释

2.多行注释

3.文档注释

二、编码规范

---

  在程序代码中适当地添加注释，可以提高程序的可读性和可维护性。好的编码规范可以使程序更易阅读和理解。

一、代码注释

通过在程序代码中添加注释可提高程序的可读性。注释中包含了程序的信息，可以帮助程序员更好地阅读和理解程序。在Java源程序文件地任意位置都可添加注释语句。注释中的文字Java编译器不进行编译，所有代码中的注释文字对程序不产生任何影响。Java语言提供了三种注释的方法，分别为单行注释、多行注释和文档注释。

1.单行注释

“ // ”为单行注释标记，从符号“ // ”开始直接到换行为止的所有内容均作为注释而被编译器忽略。

语法如下：

//注释内容

例如，以下代码为声明int型变量添加注释：

int age;   //定义int型变量，用于保存年龄信息

2.多行注释

“ /* */ ”为多行注释标记，符号“ / * ” 与“ * /”之间 的所有内容均为注释内容。注释中的内容可以换行。

语法如下：

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

3.文档注释

“ /** */ ”为文档注释标记。符号“ /** ” 与“ */ ”之间的内容均为文档注释内容。当文档注释出现在声明（如类的声明、类的成员变量的声明、类的成员方法的声明等）之前时，会被Javadoc文档工具读取作为Javadoc文档内容。除注释标记不同外，文档注释的格式与多行注释的格式相同。

二、编码规范

1.每条语句尽量独占一行，每条语句都要以分号结束。

2.声明变量时，尽量使每个变量单独占一行，即使有多个数据类型相同的变量，也要将其各自放置在单独的一行上，这样有助于添加注释。对于局部变量，应在声明的同时对其赋予初始值。

3.在Java代码中，空格仅提供分隔使用，无其他含义，应控制好空格的数量，不要写过多无用的空格。例如：

public  static  void     main   (        String     args[      ]      )

等价于

public static void main(String args[])

4.为了方便日后维护，不要使用技术性很高、难懂、易混淆的语句。因为程序的开发者和维护者可能不是同一个人，所以应尽量使用简洁、清晰的代码编写程序需要的功能。

5.对于关键的方法要多加注释，这样有助于阅读者了解代码的结构与设计思路。

Java代码的主要结构：

1.package语句要在类文件的第一行。如果类不在任何包中，可以不写package语句。

2.import语句要写在类上方、package语句下方。

3.方法必须写在类的{ }之内。方法的{ }之外的位置。方法{ }之内的变量均为局部变量。

4.除了上面几种类型的代码，其他类型代码都应该写在某个{ }中（如代码块或方法体之内）。其他类型的代码包括局部变量、内部类等。