java 如何注释

单行注释

在 Java 中，单行注释以双斜杠 // 开头，从 // 开始到行尾的内容均被视为注释，不会被编译器执行。

// 这是一个单行注释  
int x = 10; // 变量 x 赋值为 10  

多行注释

多行注释以 /* 开头，以 */ 结尾，中间的所有内容均为注释，可以跨越多行。

/*  
这是一个多行注释  
可以包含多行内容  
*/  
int y = 20;  

文档注释

文档注释以 / 开头，以 */ 结尾，通常用于生成 API 文档（如 Javadoc）。文档注释可以包含标签（如 @param、@return 等）以提供更详细的说明。

/  
 * 计算两个数的和  
 * @param a 第一个加数  
 * @param b 第二个加数  
 * @return 两个数的和  
 */  
public int add(int a, int b) {  
    return a + b;  
}  

注释的注意事项

• 单行注释适合简短说明，多行注释适合较长描述，文档注释用于生成正式文档。
• 嵌套注释需谨慎，/* */ 不能嵌套在另一个 /* */ 中，但可以包含 // 注释。
• 注释应清晰简洁，避免冗余或无意义的描述。