Java注释

简介: Java注释

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

1. 单行注释

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

image.png

2. 多行注释

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

image.png

3. 文档注释

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

image.png

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

注释的作用

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

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

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

注意事项

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

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

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

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

 

相关文章
|
Java 数据安全/隐私保护
java实现加密电话号码,有具体的加密流程注释
java实现加密电话号码,有具体的加密流程注释
31 0
|
2月前
|
Java 数据库连接 mybatis
mybatis简单案例源码详细【注释全面】——实体层(User.java)
mybatis简单案例源码详细【注释全面】——实体层(User.java)
14 0
|
9天前
|
XML 前端开发 Oracle
16:JSP简介、注释与Scriptlet、Page指令元素、Include操作、内置对象、四种属性-Java Web
16:JSP简介、注释与Scriptlet、Page指令元素、Include操作、内置对象、四种属性-Java Web
12 2
|
12天前
|
Java
【Java探索之旅】我与Java的初相识(完):注释,标识符,关键字
【Java探索之旅】我与Java的初相识(完):注释,标识符,关键字
5 0
|
18天前
|
Java 开发者
Java基础知识整理,注释、关键字、运算符
在日常的工作中,总会遇到很多大段的代码,逻辑复杂,看得人云山雾绕,这时候若能言简意赅的加上注释,会让阅读者豁然开朗,这就是注释的魅力!
39 11
|
18天前
|
算法 Java API
Java注释的重要性及实践应用
Java注释的重要性及实践应用
13 0
|
1月前
|
Java
【Java入门】Java注释和关键字
【Java入门】Java注释和关键字
24 1
|
1月前
|
Java 程序员 编译器
Java 注释
4月更文挑战第2天
|
2月前
|
Java 数据库连接 mybatis
mybatis简单案例源码详细【注释全面】——Utils层(MybatisUtils.java)
mybatis简单案例源码详细【注释全面】——Utils层(MybatisUtils.java)
14 0
|
2月前
|
Java 数据库连接 mybatis
mybatis简单案例源码详细【注释全面】——测试层(UserMapperTest.java)
mybatis简单案例源码详细【注释全面】——测试层(UserMapperTest.java)
10 0