1. 程式人生 > >Java基礎——註釋規範

Java基礎——註釋規範

一、註釋格式分類

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

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

  3、文件註釋:/**……*/

  javadoc有如下:

  

 

二、加註釋的場景:

  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){
複製程式碼