Annoation 註解

當撰寫專案時,有可能為會遇到多人一起共同編輯的狀況,為了避免別人會有看不懂的情況,我們可以利用註解的方式,來提醒自己或別人這一段程式的意思,當自己反回來在看之前寫的程式碼也比較容易。

  • 備註 : 當遇到問題時,從網路上找到答案,可以在註解中,加入解問題的思考方式,避免只有貼上參考的網址,若網址失效。當回過頭再看時,需要重頭再找一次答案。

註解分成 3 種

  1. 單行註解 //
  2. 多行註解 /* */
  3. 文件註解 /** */

當有需要產生 API 文件,使用第 3 種註解的方式

/**

* 功能描述

* 詳細功能介紹

*@param 參數

*@return 回傳內容

*@see 參考

*/

實作方式

  1. 先新增一個存放 API 文件的資料夾

2. 開啟 Android Studio

3. 點選 Tool >>> Generate JavaDoc

4. Output directory 選擇存放資料夾

5. 避免中文出現錯誤,Other command line arguments 中加入

  • encoding utf-8 -charset utf-8

6. 完成後顯示資訊

7. 開啟資料夾點選 index

8. 開啟文件

9. 顯示class 所做的項目

10. class 中有使用到的方法