Android Studio注釋詳解

一、注釋的作用

代碼注釋是提供代碼文檔信息的重要方法，包括可以幫助開發人員更容易地理解代碼、讓代碼變得更易於維護和更容易與他人共享。Android Studio在注釋方面提供了豐富的功能，包括：

1、為類、方法、欄位等提供全文描述

/**
 * MainActivity是應用的主界面
 * 界面包含一個TextView和一個Button
 */
public class MainActivity extends AppCompatActivity {
    private TextView tv_content;
    private Button btn_change;
    ...
}

2、為參數、返回值等提供描述

/**
 * 點擊按鈕改變文本顯示
 * @param view 視圖
 */
public void changeContent(View view) {
    tv_content.setText("你好，世界！");
}

3、為代碼提供代碼範例和說明

//啟動另一個Activity並傳遞參數
Intent intent = new Intent(this, SecondActivity.class);
intent.putExtra("key", value);
startActivity(intent);

4、為TODO、FIXME等標註提供支持

//TODO: 完善錯誤處理邏輯
if (data != null) {
    ...
} else {
    //FIXME: 處理data為null的情況
    Log.e(TAG, "data is null");
}

二、注釋的類型

Android Studio提供了多種注釋類型，包括：

1、塊注釋

/*
 * 這是一個多行注釋
 * 注釋內容可以跨越多行
 */

2、行注釋

// 這是一個單行注釋

3、文檔注釋

/**
 * 這是一個文檔注釋
 * 可以包含HTML標籤和注釋標記
 *
 * @param param 參數
 * @return 返回值
 * @throws Exception 異常說明
 */
public String doSomething(String param) throws Exception {
    ...
}

三、注釋的格式

注釋的格式是約定成俗的，在團隊開發中必須統一遵守，包括：

1、注釋前空格

//正確的注釋格式
int a = 1; //注釋
//錯誤的注釋格式
int b = 2;//注釋

2、注釋分行

//正確的注釋格式
int c = 3;
//注釋
int d = 4;
//錯誤的注釋格式
int e = 5;//注釋
int f = 6;//注釋

3、注釋符號

//使用//進行單行注釋
/*使用/* */進行多行注釋*/
/**使用/** */進行文檔注釋*/

4、文檔注釋標記

/**
 * 這是一個文檔注釋
 *
 * @param param 參數
 * @return 返回值
 * @throws Exception 異常說明
 */

四、注釋的示例

下面是一個關於Android Studio注釋的完整示例：

/**
 * MainActivity是應用的主界面
 * 界面包含一個TextView和一個Button
 *
 * TODO: 完善錯誤處理邏輯
 * FIXME: 處理data為null的情況
 */
public class MainActivity extends AppCompatActivity {
    private TextView tv_content;
    private Button btn_change;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        tv_content = (TextView) findViewById(R.id.tv_content);
        btn_change = (Button) findViewById(R.id.btn_change);

        //單行注釋
        //為按鈕設置點擊事件
        btn_change.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                changeContent(v);
            }
        });
    }

    /**
     * 點擊按鈕改變文本顯示
     * @param view 視圖
     */
    public void changeContent(View view) {
        tv_content.setText("你好，世界！");
    }
}