标签：
在Java编程语言中，注释是一种非执行代码的文本，主要用于解释代码、提高代码的可读性和维护性。Java 支持三种类型的注释，每种类型都有其特定的用途和格式：
单行注释 (//)
单行注释用于注释一行代码，通常是简短的说明或解释某行代码的目的。它以双斜杠开头，一直到行尾。
// 这是一个单行注释，用于解释接下来的代码
int sum = 5 + 3; // 计算5和3的和
Java
多行注释 (/* ... */)
多行注释用于注释多行代码或较长的说明。它以 /* 开头，以 */ 结尾。可以跨越多行，非常适合用于方法、类的详细描述或临时注释掉一块代码。
/*
* 这是一个多行注释
* 用于详细说明或注释掉一段代码
*/
int product = 5 * 3; // 计算5和3的乘积
/*
* 这段代码暂时注释掉
* int difference = 5 - 3;
*/
Java
文档注释 (/** ... */)
文档注释用于生成标准化的API文档，是一种特殊的多行注释。它以 /** 开头，以 */ 结尾。通常用在类、方法、构造函数或字段前。Javadoc 工具可以提取这些注释，并生成HTML格式的文档。
/**
* 计算两个整数的和
*
* @param a 第一个整数
* @param b 第二个整数
* @return 两个整数的和
*/
public int add(int a, int b) {
return a + b;
}
/**
* 这是一个简单的Java类示例
* 用于展示Java文档注释
*/
public class Example {
/** 类的成员变量 */
private int value;
/**
* 一个简单的构造方法
*
* @param value 初始化的值
*/
public Example(int value) {
this.value = value;
}
/**
* 获取成员变量的值
*
* @return 成员变量的值
*/
public int getValue() {
return value;
}
}
Java
使用文档注释生成Javadoc
你可以使用JDK自带的javadoc工具从文档注释中生成API文档：
javadoc -d doc Example.java
Shell
以上命令会在当前目录下创建一个名为doc的文件夹，存放生成的HTML格式的文档。
总结
- 单行注释 (
//)：适用于简短的说明。 - 多行注释 (
/* ... */)：适用于较长的说明或注释掉大块代码。 - 文档注释 (
/** ... */)：用于生成API文档，适用类、方法等的详细说明。
使用适当的注释可以大大提高代码的可维护性和可读性，同时也帮助其他开发人员更好地理解代码的功能和意图。
标签： 来源：
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。