2015年12月9日 星期三

[Android] 註解的推薦寫法 - Android Studio

註解很重要人人都知道,但是依照特殊的格式來寫,可以讓你的程式更好讀。

在Android Studio當中,當你選擇某個涵式時,按下快捷鍵可以閱讀此方法的註解。

MAC : fn + F1

Windows: CTRL + Q

你就會看到這樣的畫面





















我們也想要我們的涵式也能用這種格式顯示,該怎麼做呢?

其實滿簡單的,大部分的人可能只需要用到這三個參數

@param - 說明參數的內容

@return - 說明回傳的內容

@see - 推薦看別的東西

在這邊示範一下簡單的寫法



這樣顯示出來的效果會像這樣



這樣一來你的程式即使在其他類別,也可以很簡單的看到註解,也可以比較方便給人家使用。