AI全栈开发 - Java：注释

Java 有三种注释方式：

1. 单行注释

// 这是单行注释
int age = 18; // 也可以写在代码后面

2. 多行注释

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

3. 文档注释（Javadoc）

/**
 * 这是文档注释
 * 用于生成 API 文档
 * @param name 用户名
 * @return 问候语
 */
public String greet(String name) {
    return "Hello, " + name;
}

调用 greet 方法后，把鼠标放到该方法上，提示窗会展示出你给这个方法写的文档注释。

怎么将文档注释生成文档呢？

1. 工具 -> Generate JavaDoc...

2. 选择要生成文档的范围、文档生成后保存的地址，然后点击生成

3. 文档生成后会在浏览器自动打开

4. 点击具体的类，就能查看类里面具体的内容了。

4. 要点总结

类型	语法	用途
单行注释	//	简短说明
多行注释	/* ... */	大段说明，不能嵌套
文档注释	/** ... */	生成 Javadoc 文档，支持 @param、@return、@author 等标签

注释不会被编译器编译，不影响程序运行，主要用于提高代码的可读性和可维护性。