编辑“︁Java注释”︁

{{DISPLAYTITLE:Java注释}}  
'''Java注释'''是源代码中用于解释代码功能、提高可读性的非执行文本。注释不会被编译器处理，但对开发者维护代码和理解逻辑至关重要。Java支持三种注释类型：单行注释、多行注释和文档注释。  

== 注释类型 ==  

=== 1. 单行注释 ===  
以<code>//</code>开头，仅注释当前行内容。适用于简短说明。  

<syntaxhighlight lang="java">  
public class Main {  
    public static void main(String[] args) {  
        // 输出"Hello World"到控制台  
        System.out.println("Hello World");  
    }  
}  
</syntaxhighlight>  

=== 2. 多行注释 ===  
以<code>/*</code>开头、<code>*/</code>结尾，可跨越多行。常用于复杂逻辑说明。  

<syntaxhighlight lang="java">  
/*  
 * 这是一个多行注释示例  
 * 计算两个数的和  
 */  
public int add(int a, int b) {  
    return a + b;  
}  
</syntaxhighlight>  

=== 3. 文档注释 ===  
以<code>/**</code>开头、<code>*/</code>结尾，用于生成API文档（通过<code>javadoc</code>工具）。支持HTML标签和Javadoc标签（如<code>@param</code>、<code>@return</code>）。  

<syntaxhighlight lang="java">  
/**  
 * 计算两个整数的乘积  
 * @param a 第一个乘数  
 * @param b 第二个乘数  
 * @return 返回a与b的乘积  
 */  
public int multiply(int a, int b) {  
    return a * b;  
}  
</syntaxhighlight>  

== 实际应用场景 ==  

=== 代码维护 ===  
注释帮助团队理解代码意图，例如：  

<syntaxhighlight lang="java">  
// 使用快速排序算法优化性能（时间复杂度O(n log n)）  
void sort(int[] array) {  
    Arrays.sort(array);  
}  
</syntaxhighlight>  

=== API文档生成 ===  
通过文档注释生成HTML文档：  
1. 编写包含<code>@param</code>和<code>@return</code>的注释。  
2. 运行命令：<code>javadoc Main.java</code>。  

== 注释规范 ==  

* '''清晰简洁'''：避免冗余描述。  
* '''及时更新'''：修改代码时同步更新注释。  
* '''避免过度注释'''：仅对复杂逻辑或非直观代码添加注释。  

=== 反例 ===  
<syntaxhighlight lang="java">  
// 给i加1  
i++;  // 无意义的注释  
</syntaxhighlight>  

== 注释与代码结构的关系 ==  

<mermaid>  
flowchart TD  
    A[编写代码] --> B{是否需要解释?}  
    B -->|是| C[添加注释]  
    B -->|否| D[继续开发]  
    C --> E[确保注释与代码同步]  
</mermaid>  

== 数学公式示例（可选） ==  
若需在注释中描述算法公式，可使用LaTeX语法：  
<math>  
\sum_{i=1}^{n} (x_i + y_i)  
</math>  

== 总结 ==  
Java注释是提升代码可维护性的关键工具，合理使用单行、多行和文档注释能显著提高团队协作效率。初学者应从基础注释开始，逐步掌握文档注释的规范写法。

[[Category:编程语言]]
[[Category:Java]]
[[Category:Java基础]]