Java注释

简介: Java注释

在Java编程中,注释是用来给代码添加说明或解释的文字,它们不会被编译器执行。Java提供了三种不同类型的注释,分别是单行注释、多行注释和文档注释。

1. 单行注释

单行注释以//开始,从//到该行末尾的所有内容都被视为注释。

image.png

2. 多行注释

多行注释以/*开始,以*/结束,它们之间的所有内容都是注释。

image.png

3. 文档注释

文档注释以/**开始,以*/结束。它们通常用于生成API文档,如JavaDoc。文档注释可以用来解释类、方法、变量等的用途、参数、返回值等。

image.png

在文档注释中,你还可以使用特定的标签来提供额外的信息,如@param(描述参数)、@return(描述返回值)、@throws(描述可能抛出的异常)等。

注释的作用

· ·提高代码的可读性:注释可以帮助其他开发者(或未来的你)理解代码的功能和用途。

· ·记录设计决策:注释可以用来解释为何选择某种实现方式或设计决策。

· ·临时注释:在开发过程中,你可能会添加一些临时注释来标记需要回头检查或修改的代码段。

注意事项

·注释应该清晰、简洁,避免冗余和含糊不清的表述。

·不要过度使用注释,特别是当代码本身已经足够清晰时。

·定期审查并更新注释,以确保它们与代码保持同步。

使用好注释是编写高质量代码的关键部分,它可以帮助你和其他开发者更有效地理解和维护代码库。

 

相关文章
|
2月前
|
Java 编译器
Java健壮性 Java可移植性 JDK, JRE, JVM三者关系 Java的加载与执行原理 javac编译与JAVA_HOME环境变量介绍 Java中的注释与缩进 main方法的args参数
Java健壮性 Java可移植性 JDK, JRE, JVM三者关系 Java的加载与执行原理 javac编译与JAVA_HOME环境变量介绍 Java中的注释与缩进 main方法的args参数
34 1
|
2月前
|
存储 Java 程序员
Java入门——基本语法(注释、字面量、变量、使用变量的注意事项、关键字、标识符)
Java入门——基本语法(注释、字面量、变量、使用变量的注意事项、关键字、标识符)
28 2
|
2月前
|
算法 Java Go
【经典算法】LeetCode 67. 二进制求和(Java/C/Python3/Golang实现含注释说明,Easy)
【经典算法】LeetCode 67. 二进制求和(Java/C/Python3/Golang实现含注释说明,Easy)
23 2
|
2月前
|
存储 算法 Java
【经典算法】Leetcode 141. 环形链表(Java/C/Python3实现含注释说明,Easy)
【经典算法】Leetcode 141. 环形链表(Java/C/Python3实现含注释说明,Easy)
17 2
|
2月前
|
算法 Java Go
【经典算法】LeetCode 69. x 的平方根(Java/C/Python3/Golang实现含注释说明,Easy)
【经典算法】LeetCode 69. x 的平方根(Java/C/Python3/Golang实现含注释说明,Easy)
22 1
|
2月前
|
Java C# 容器
第一行Java代码的注释和相关解读
第一行Java代码的注释和相关解读
15 0
|
2月前
|
Java API
Java基础之注释
Java中的注释用于添加代码说明,分为单行、多行和文档注释。单行注释以`//`开始,多行注释以`/*...*/`包围,文档注释`/**...*/`用于生成API文档,如Javadoc。`@param`、`@return`等标签提供方法详情。注意,Java不支持嵌套注释。运行包含文档注释的代码,可通过`javadoc`命令生成API文档。示例代码展示了如何创建和使用文档注释。
14 0
|
2月前
|
算法 Java Go
【经典算法】LeetCode 392 判断子序列(Java/C/Python3/Go实现含注释说明,Easy)
【经典算法】LeetCode 392 判断子序列(Java/C/Python3/Go实现含注释说明,Easy)
32 0
|
2月前
|
算法 Java Go
【经典算法】LeetCode 1103 分糖果 II(Java/C/Python3实现含注释说明,Easy)
【经典算法】LeetCode 1103 分糖果 II(Java/C/Python3实现含注释说明,Easy)
38 0
|
2月前
|
存储 算法 Java
【经典算法】LeetCode112. 路径总和(Java/C/Python3/Go实现含注释说明,Easy)
【经典算法】LeetCode112. 路径总和(Java/C/Python3/Go实现含注释说明,Easy)
21 0