一、单行注释
单行注释以两个正斜杠(//)开始,直到行尾的所有内容都被视为注释
// 这是一个单行注释
int number = 10; // 这也是一个单行注释,紧跟在代码后面
二、多行注释(别名块注释)
多行注释以/*开始,以*/结束。它们可以跨越多行,非常适合对代码块或代码段进行解释说明。
/* 这是一个多行注释
它可以跨越多行
对代码块进行说明 */
int sum = 0;
for(int i = 0; i < 10; i++) {
sum += i; // 累加求和
}
三、文档注释(也称为Javadoc注释)
文档注释以/**开始,以*/结束。它们通常用于生成API文档,并可以包含有关类、方法、变量等的描述信息。文档注释可以跨越多行,并且支持HTML标签来格式化文档。
/**
* 计算并返回从1到n的整数和。
*
* @param n 整数n
* @return 从1到n的整数和
*/
public static int sum(int n) {
int sum = 0;
for(int i = 1; i <= n; i++) {
sum += i;
}
return sum;
}
总结:
在编写Java代码时,合理使用注释是非常重要的,因为它们可以帮助其他开发者(或未来的你)更好地理解代码的意图和功能。然而,过度使用注释也可能使代码变得难以阅读和维护,因此应该在需要时才添加注释,并确保注释是准确和有用的。
1245

被折叠的 条评论
为什么被折叠?



