Java:基础笔记2 注释类型

注释既可以让代码更容易理解，也有助于维护和调试代码。注释的一般使用场景

• 记录类、方法或变量的作用
• 记录类、方法或变量的作者、创建日期和修改日期
• 解释复杂的代码逻辑
• 标记需要修改或改进的代码段

注释类型

单行注释

以 // 开头，可以占据一整行，也可以是一行代码后面的注释。示例

// Integer car number
int car = 12;

多行注释

一般是以 /* 开头和 */ 结尾的注释，可以跨越多行。这种注释通常用于描述类、方法或模块的作用、作者和其他元信息。还有一类比较特殊的多行注释，是 Java Doc 注释，它是以 /** 开头和 */ 结尾的注释。JavaDoc 注释的目的是自动生成类、方法和变量的文档。它使用特定的标签来描述程序中的各个元素，例如 @param、@return、@author 等。
使用 JavaDoc 注释可以更好地文档化代码，方便开发者和使用者理解类、方法或模块的用途和功能。JavaDoc 注释可以通过运行 javadoc 工具自动生成 HTML 格式的文档。示例如下:

/**
 * 使用 JavaDoc 注释的示例类
 * 
 * @author 作者名
 */
public class ExampleClass {

    /**
     * 添加两个数
     * 
     * @param a 第一个数
     * @param b 第二个数
     * @return 两个数的和
     */
public int add(int a, int b) {
        return a + b;
    }
}

Java Doc 生成

要生成 Javadoc，可以使用命令 javadoc [options] [packagenames] [sourcefiles] [@files] 其中：

• options：指定命令行选项，选项之间用空格隔开。
• packagenames：要生成文档的包名称，可以指定多个。
• sourcefiles：要生成文档的源代码文件，可以指定多个。
• @files：指定一个文件，该文件中包含要生成文档的类名或包名。

最简单的使用方式是直接指定源代码文件路径 javadoc Example.java。 这将生成 Example.html 文件，包含类 Example 的文档信息。
如果需要自定义输出目录和其他选项，可以使用如下命令：

javadoc -d /path/to/output/directory -sourcepath /path/to/source/files -classpath /path/to/class/files Example.java

其中：

• -d：指定输出目录。
• -sourcepath：指定源代码文件的路径。
• -classpath：指定类文件的路径。
  生成 Javadoc 后，可以在浏览器中打开输出目录下的 index.html 文件，查看生成的文档。