在Java中,有三种类型的注释

简介: 在Java中,有三种类型的注释

在Java中,有三种类型的注释:

  1. 单行注释
    单行注释以两个斜线(//)开始,直到该行的末尾都是注释内容。单行注释主要用于简短的说明。

    // 这是一个单行注释
    int x = 10; // 这是变量x的初始化
    
  2. 多行注释
    多行注释由 /* 开始,由 */ 结束,可以跨越多行。这种类型的注释通常用于提供更详细的说明或解释代码块。

    /**
     * 这是一个多行注释的例子
     * 它可以跨越多行
     */
    public class MyClass {
         
        // ...
    }
    
  3. 文档注释(Javadoc注释)
    文档注释是一种特殊的多行注释,以 /** 开始,以 */ 结束。它们用于生成API文档,通常放在类、方法和字段的前面,用来描述其功能、参数、返回值和可能抛出的异常等。

    /**
     * 这是一个文档注释的例子
     *
     * @param arg 参数的描述
     * @return 返回值的描述
     * @throws Exception 如果发生错误,则抛出此异常
     */
    public String myMethod(String arg) throws Exception {
         
        // ...
    }
    

文档注释中的某些标签,如 @param, @return, @throws, 等,被Javadoc工具解析,用于生成HTML格式的API文档。这些注释对于其他开发人员理解和使用你的代码非常有帮助。同时,IDE(如Eclipse、IntelliJ IDEA等)也能识别这些注释,并在代码提示和快速查看时显示相关的信息。

相关文章
|
1月前
|
Java
【Java】如果一个集合中类型是String如何使用拉姆达表达式 进行Bigdecimal类型计算?
【Java】如果一个集合中类型是String如何使用拉姆达表达式 进行Bigdecimal类型计算?
25 0
|
1月前
|
Java
java中的泛型类型擦除
java中的泛型类型擦除
13 2
|
Java 数据安全/隐私保护
java实现加密电话号码,有具体的加密流程注释
java实现加密电话号码,有具体的加密流程注释
24 0
|
1月前
|
存储 Java
JAVA字符串与其他类型数据的转换
JAVA字符串与其他类型数据的转换
28 4
|
1月前
|
Shell
Flume【问题记录 01】【at org.apache.flume.node.Application.main(Application.java:xxx) 类问题整理+其他类型问题总结】【避坑指南】
【2月更文挑战第17天】Flume【问题记录 01】【at org.apache.flume.node.Application.main(Application.java:xxx) 类问题整理+其他类型问题总结】【避坑指南】
53 2
|
1月前
|
Java 数据库连接 mybatis
mybatis简单案例源码详细【注释全面】——实体层(User.java)
mybatis简单案例源码详细【注释全面】——实体层(User.java)
13 0
|
1天前
|
安全 Java 程序员
Java 泛型类型:变幻中的不变性
【4月更文挑战第21天】
4 1
Java 泛型类型:变幻中的不变性
|
4天前
|
Java 开发者
Java基础知识整理,注释、关键字、运算符
在日常的工作中,总会遇到很多大段的代码,逻辑复杂,看得人云山雾绕,这时候若能言简意赅的加上注释,会让阅读者豁然开朗,这就是注释的魅力!
37 11
|
4天前
|
存储 Java
JAVA变量类型
JAVA变量类型
11 0
|
9天前
|
存储 算法 安全
什么是Java泛型类型?
【4月更文挑战第13天】
12 0
什么是Java泛型类型?