在Java中,有三种类型的注释:
单行注释:
单行注释以两个斜线(//
)开始,直到该行的末尾都是注释内容。单行注释主要用于简短的说明。// 这是一个单行注释 int x = 10; // 这是变量x的初始化
多行注释:
多行注释由/*
开始,由*/
结束,可以跨越多行。这种类型的注释通常用于提供更详细的说明或解释代码块。/** * 这是一个多行注释的例子 * 它可以跨越多行 */ public class MyClass { // ... }
文档注释(Javadoc注释):
文档注释是一种特殊的多行注释,以/**
开始,以*/
结束。它们用于生成API文档,通常放在类、方法和字段的前面,用来描述其功能、参数、返回值和可能抛出的异常等。/** * 这是一个文档注释的例子 * * @param arg 参数的描述 * @return 返回值的描述 * @throws Exception 如果发生错误,则抛出此异常 */ public String myMethod(String arg) throws Exception { // ... }
文档注释中的某些标签,如 @param
, @return
, @throws
, 等,被Javadoc工具解析,用于生成HTML格式的API文档。这些注释对于其他开发人员理解和使用你的代码非常有帮助。同时,IDE(如Eclipse、IntelliJ IDEA等)也能识别这些注释,并在代码提示和快速查看时显示相关的信息。