【java】注释

简介: 在编写程序时,为了使代码易于阅读,通常会在实现功能的同时为代码添加一些注释。注释是对程序的某个功能或者某行代码的解释说明,它能够让开发者在后期阅读和使用代码时能更容易理解代码的作用。


Java中的注释

在编写程序时,为了使代码易于阅读,通常会在实现功能的同时为代码添加一些注释。注释是对程序的某个功能或者某行代码的解释说明,它能够让开发者在后期阅读和使用代码时能更容易理解代码的作用。

注释只在Java 源文件中有效,在编译程序时编译器会忽略这些注释信息,不会将其编译到 class 字节码文件中。

Java 中的注释有三种类型,具体如下。

1.单行注释

单行注释通常用于对程序中的某一行代码进行注释,用符号”//“表示,"//"后面为注释说明的内容,具体示例如下:

intc=10;   //定义一个整型变量c

2.多行注释

多行注释顾名思义就是可以同时注释多行内容,它以符号”/“开头,并以符号”/“结尾,具体示例如下:

/*定义一个整型变量x

将5赋值给变量x*/

intx;

x=5;

3.文档注释

文档注释通常是对程序中某个类或类中的方法进行的系统性的解释说明,开发人员可以使用 JDK 提供的 javadoc 工具将文档注释提取出来生成一份 API 帮助文档。文档注释以符号“/*”开头,并以符号“/”结尾,具体示例如下:

/**

*Title:HelloNorid类

*@author srx

*@version 1.0

*/

publicclassHelloworld {

/**

*这是一个 main ()方法人口

* @param args 参数名

*/

   publicstaticvoidmain(String[] args){

       System.out .printitln("这是第一个 Java程序!");

   }

}

注意:

在java中,有的注释可以嵌套使用,有的则不可以,下面列举两种具体的情况。

(1)多行注释"/..../"中可以嵌套使用单行注释"//",具体示例如下:

/*int c=10;    //定义一个整型的c

 int x=5;*/

(2)多行注释"/...../"中不能嵌套多行注释"/.../",具体示例如下:

/*

 

   /*int c=10;*/

*/


相关文章
|
9天前
|
存储 Java 程序员
Java入门——基本语法(注释、字面量、变量、使用变量的注意事项、关键字、标识符)
Java入门——基本语法(注释、字面量、变量、使用变量的注意事项、关键字、标识符)
16 2
|
9天前
|
Java API
Java基础之注释
Java中的注释用于添加代码说明,分为单行、多行和文档注释。单行注释以`//`开始,多行注释以`/*...*/`包围,文档注释`/**...*/`用于生成API文档,如Javadoc。`@param`、`@return`等标签提供方法详情。注意,Java不支持嵌套注释。运行包含文档注释的代码,可通过`javadoc`命令生成API文档。示例代码展示了如何创建和使用文档注释。
8 0
|
10天前
|
算法 Java Go
【经典算法】LeetCode 392 判断子序列(Java/C/Python3/Go实现含注释说明,Easy)
【经典算法】LeetCode 392 判断子序列(Java/C/Python3/Go实现含注释说明,Easy)
14 0
|
10天前
|
算法 Java Go
【经典算法】LeetCode 1103 分糖果 II(Java/C/Python3实现含注释说明,Easy)
【经典算法】LeetCode 1103 分糖果 II(Java/C/Python3实现含注释说明,Easy)
12 0
|
10天前
|
存储 算法 Java
【经典算法】LeetCode112. 路径总和(Java/C/Python3/Go实现含注释说明,Easy)
【经典算法】LeetCode112. 路径总和(Java/C/Python3/Go实现含注释说明,Easy)
9 0
|
10天前
|
存储 算法 Java
【经典算法】LeetCode 125. 验证回文串(Java/C/Python3实现含注释说明,Easy)
【经典算法】LeetCode 125. 验证回文串(Java/C/Python3实现含注释说明,Easy)
5 0
|
10天前
|
算法 Java Go
【经典算法】LeetCode 100. 相同的树(Java/C/Python3/Go实现含注释说明,Easy)
【经典算法】LeetCode 100. 相同的树(Java/C/Python3/Go实现含注释说明,Easy)
5 0
|
10天前
|
算法 Java Go
【经典算法】LeetCode 58.最后一个单词的长度(Java/C/Python3/Go实现含注释说明,Easy)
【经典算法】LeetCode 58.最后一个单词的长度(Java/C/Python3/Go实现含注释说明,Easy)
11 0
|
10天前
|
算法 Java 大数据
【经典算法】LeetCode 283. 移动零(Java/C/Python3/Go实现含注释说明,Easy)
【经典算法】LeetCode 283. 移动零(Java/C/Python3/Go实现含注释说明,Easy)
7 0
|
10天前
|
算法 Java Go
【经典算法】LeetCode 2两数相加(Java/C/Python3/Go实现含注释说明,中等)
【经典算法】LeetCode 2两数相加(Java/C/Python3/Go实现含注释说明,中等)
9 0