Java基礎——注釋規範

標籤：png   logs   基本   author   技術   src   lin   com   javadoc   

一、注釋格式分類：

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

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

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

　　javadoc有如下：

　　

 

二、加註釋的情境：

　　1. 基本注釋（必須加）
　　　　(a)類（介面）的注釋
　　　　(b)建構函式的注釋
　　　　(c)方法的注釋
　　　　(d)全域變數的注釋
　　　　(e)欄位/屬性的注釋

　　2. 特殊必須加註釋（必須加）
　　　　(a)典型演算法 必須有注釋。
　　　　(b)在代碼不明晰處必須有注釋。
　　　　(c)在代碼修改處加上修改標識的注釋。
　　　　(d)在迴圈和邏輯分支組成的代碼中加註釋。
　　　　(e)為他人提供的介面必須加詳細注釋。

三、注釋樣本

　　　　類的注釋

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

 

　　　　欄位屬性注釋

private String username;//使用者名稱，欄位屬性注釋

　　　　全域變數注釋

 

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

 

　　　　方法注釋

 

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

 

Java基礎——注釋規範