Java 教程-详解 Java 注解

Java注释是程序中不被编译器和解释器执行的语句。

为什么我们在代码中使用注释？

注释用于通过添加代码的细节来使程序更易读。
它使维护代码变得容易，并且有助于发现错误。
注释可用于提供关于变量、方法、类或任何语句的信息或解释。
它还可以用于阻止程序代码的执行，以测试替代代码。

Java 注释的类型

Java 中有三种类型的注释：

单行注释
多行注释
文档注释

1) Java 单行注释

单行注释用于注释单行代码。它是注释语句的最常见和最简单的方式。

单行注释以两个正斜杠 (//) 开头。在 // 之后的任何文本都不会被 Java 执行。

句法：

//这是单行注释

让我们在 Java 程序中使用单行注释。

CommentExample1.java

public class CommentExample1 {    
public static void main(String[] args) {    
int i=10; // i 是一个值为 10 的变量  
System.out.println(i);  //打印变量 i  
}    
}

输出：

2) Java 多行注释

多行注释用于注释多行代码。它通常用于解释复杂的代码块或一次性注释多行代码（因为使用单行注释会比较麻烦）。

多行注释使用 / 和 / 将注释的文本包围起来。/ 和 / 之间的任何文本都不会被 Java 执行。

句法：

/*  
这是  
多行  
注释  
*/

让我们在 Java 程序中使用多行注释。

CommentExample2.java

public class CommentExample2 {    
public static void main(String[] args) {    
/* 让我们声明并  
 在java中打印变量。*/    
  int i=10;    
    System.out.println(i);    
/* float j = 5.9; 
    float k = 4.4; 
    System.out.println( j + k ); */    
}    
}

输出：

注意：通常 // 用于简短的注释， / / 用于较长的注释。

3) Java 文档注释

文档注释通常用于为项目或软件应用程序编写大型程序，因为它有助于生成 API 文档。API 文档提供了关于代码中使用的类、方法、参数等的详细信息，供其他开发人员参考。

要创建文档 API，我们使用 javadoc 工具。文档注释被放置在 /* 和 / 之间，以区分其它类型的注释。它们可以包含详细的说明、参数说明、返回值说明以及其他相关信息，以帮助生成全面的文档。

句法：

/** 
* 
*我们可以使用各种标签来描述参数 
*或标题或作者姓名 
*我们也可以使用HTML标签  
* 
*/

javadoc 标签

文档注释中的一些常用标签：

标签	句法	描述
{@docRoot}	{@docRoot}	描述从任何页面生成的文档的根目录的相对路径。
@author	@author name - text	添加班级的作者。
@code	{@code text}	以代码字体显示文本而不将其解释为 html 标记或嵌套的 javadoc 标记。
@version	@version version-text	在使用 -version 选项时指定“版本”副标题和版本文本。
@since	@since release	将“Since”标题和 since 文本添加到生成的文档中。
@param	@param parameter-name description	将具有给定名称和描述的参数添加到“参数”部分。
@return	@return description	每个返回某些东西的方法都是必需的（void 除外）

让我们在 Java 程序中使用 Javadoc 标记。

计算.java

import java.io.*;  
  
/** 
 * <h2> 数字的计算</h2> 
 * 本程序实现了一个应用 
 * 进行数字相加等操作  
 * 并打印结果  
 * <p> 
 * <b>注意：</b>注释使代码可读且  
 * 容易明白。 
 *  
 * @author Anurati  
 * @version 16.0 
 * @自 2021-07-06 以来 
 */  
   
 public class Calculate{  
    /** 
     * 此方法计算两个整数的总和。 
     * @param input1 这是 sum() 方法的第一个参数 
     * @param input2 这是 sum() 方法的第二个参数。 
     * @return int 这将返回 input1 和 input2 的加法 
     */   
    public int sum(int input1, int input2){  
        return input1 + input2;  
    }  
    /** 
    * 这是 sum() 方法的主要方法用途。 
    * @param args 未使用 
    * @see IO异常  
    */    
    public static void main(String[] args) {  
        Calculate obj = new Calculate();  
        int result = obj.sum(40, 20);  
  
        System.out.println("Addition of numbers: " + result);  
    }    
 }

通过javac工具编译：

创建文档

通过javadoc工具创建文档 API ：

现在，在当前目录中为Calculate类创建了HTML]文件，即abcDemo。打开HTML文件，我们可以看到通过文档注释提供的Calculate类的解释。

Java 注释是否可执行？

Ans：众所周知，Java的注释不是由编译器或解释器执行的，但是，在编译器对代码进行词法转换之前，为了便于处理，代码的内容被编码成ASCII。

测试.java

public class Test{  
    public static void main(String[] args) {  
        //下面的注释会被执行  
// \u000d System.out.println("Java 注释被执行！！");  
    }  
}

输出：

上面的代码产生输出是因为编译器在词法转换前将Unicode字符 u000d解析为换行，因此代码转换如下：

测试.java

public class Test{  
    public static void main(String[] args) {  
        //下面的注释会被执行 
System.out.println("Java注释执行完毕！！");  
    }  
}

因此，Unicode 字符将打印语句移到下一行，并作为普通 Java 代码执行。

Java 教程-详解 Java 注解

为什么我们在代码中使用注释？

Java 注释的类型

1) Java 单行注释

2) Java 多行注释

注意：通常 // 用于简短的注释， / / 用于较长的注释。

3) Java 文档注释

javadoc 标签

Java 注释是否可执行？

推荐文章

其它