注释(单行注释、多行注释、文档注释)

注释就是我们在写程序的时候会经常的加入注释,第一方便我们的阅读,第二用来提高程序的可读性。java语言允许程序员在程序中写上一些说明性的文字,这些说明性的文字就是注释。注释的内容不会出现在字节码中,即java编译器编译时会跳过注释语句,在java中根据注释的功能不同,主要分为单行注释、多行注释和文档注释。
1,单行注释
单行注释是以“//”开头的后面的内容就是注释。
2,多行注释
多行注释是以“/”开头和以“/”结尾的,之间的内容均为注释,我们也可以使用多行注释作为行内注释。但是使用时要注意,多行注释不能嵌套使用。
3,文档注释
文档注释是以“/**”开头以“*/”结尾注视中包含这一些说明性的文字及一些javaDoc标签(后期写项目时,可以生成项目的API)
写注释是一个非常非常好的习惯,建议以后写完每一个方法每一个类上面都写上注释,告诉别人这个方法这个类是干什么的。即使你写的方法名称和类名称写的非常好,可能别人通过这个英文名称就知道是干嘛的了但是仍然建议加上注释,这是一个非常好的习惯,建议你们从一开始就养成这个非常好的习惯。

### Java 中的不同注释类型及其使用方法 #### 单行注释 单行注释用于对代码的一行或多行提供简单的解释或说明。它通过两个连续的斜杠 `//` 开头,直到当前行结束为止[^1]。 这种类型的注释适合于快速描述某一行代码的功能或者临时禁用某些代码。 ```java public class Example { public static void main(String[] args) { int a = 10; // 定义整型变量a并赋初值为10 // System.out.println(a); // 此行为被注释掉的打印语句 } } ``` #### 多行注释 多行注释允许开发者在一个范围内的多行上添加详细的注解信息。它的起始标记是 `/*`,终止标记是 `*/`[^3]。需要注意的是,多行注释内部不能嵌套另一个多行注释[^2]。 ```java public class MultiLineCommentExample { public static void main(String[] args) { /* * 这是一个多行注释的例子。 * 可以跨越多行来详细描述逻辑或其他相关内容。 */ System.out.println("这是一个测试"); } } ``` #### 文档注释 文档注释是一种特殊的注释形式,主要用于生成API文档。其语法是以 `/**` 开始,并以 `*/` 结束[^4]。这类注释通常位于类、接口、字段以及方法定义之前,能够被 JDK 提供的工具 javadoc 解析成 HTML 格式的文档[^5]。 ```java /** * This is the documentation comment. * * @author John Doe * @version 1.0 */ public class DocCommentExample { /** * A method that prints hello world to console. */ public void sayHello() { System.out.println("Hello, World!"); } } ``` 要生成文档,可以运行如下命令: ```bash javadoc -d f:\output_directory -author -version FileName.java ``` 这会将指定 `.java` 文件中的所有文档注释放入到给定路径下的HTML文件中。 --- ### 各种注释的区别总结表 | **特性** | **单行注释 (`//`) ** | **多行注释 (`/* ... */`) ** | **文档注释 (`/** ... */`) ** | |-------------------|----------------------------|----------------------------------|------------------------------| | **适用场景** | 简短说明 | 较复杂的跨多行说明 | 类、方法等结构化说明 | | **是否支持嵌套** | 不涉及 | 不支持 | 支持 | | **功能扩展** | 无 | 无 | 自动生成 API 文档 | ---
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值