天天看點

Java基礎——注釋規範 - LeviZhuang

Java基礎——注釋規範

一、注釋格式分類:

  1、單行(single-line)注釋://……

  2、塊(block)注釋:/*……*/

  3、文檔注釋:/**……*/

  javadoc有如下:

  

Java基礎——注釋規範 - LeviZhuang

二、加注釋的場景:

  1. 基本注釋(必須加)

    (a)類(接口)的注釋

    (b)構造函數的注釋

    (c)方法的注釋

    (d)全局變量的注釋

    (e)字段/屬性的注釋

  2. 特殊必須加注釋(必須加)

    (a)典型算法 必須有注釋。

    (b)在代碼不明晰處必須有注釋。

    (c)在代碼修改處加上修改辨別的注釋。

    (d)在循環和邏輯分支組成的代碼中加注釋。

    (e)為他人提供的接口必須加詳細注釋。

三、注釋示例

    類的注釋——請使用IDE的模闆定義類注釋模闆

/**
 * 測試類
 * @author 
 * @version 1.0
 * 
 *
 */
public class Test01 {      

    字段屬性注釋

private String username;//使用者名,字段屬性注釋      

    全局變量注釋

  /**統計次數*/
    private final int count= 18;      

    方法注釋

  /**
     * 測試方法
     * @param n 循環次數
     * 
     */
    @Test
    public void fun1(int n){