注釋也是一門藝術,好的注釋不僅便于後期維護,還可以生成接口文檔便于前端查閱。
有必要的話可以将自己的注釋寫成一個模闆,以後用的時候直接複制就行。
關于在myeclipse中如何設定注釋模闆,請參考:https://blog.csdn.net/u012463017/article/details/52189802
文檔注釋中是支援html标簽的 是以可以定制自己的模闆。
下面是我目前用注釋模闆:
- @author
- @param
- @return 傳回Message對象<br/>
- <b>内容:</b><p>message: "", status: true, list: null, listSize: 0, map: null</p>
- <p>message的内容為提示字元串</p>
- <p>status為狀态 true為真 false為假</p>
- <p>list 為資料集合</p>
- <p>listSize 為集合長度</p>
-
<p>map為 鍵值對的資料集合</p>
*/
// 這是單行注釋
/*
*
**這是多行注釋
*
*/
/**
*這是文檔注釋
*/
注釋關鍵字:
@author 作者
@param 參數
@return 傳回值
@exception 異常
@see 引用其他類
@version 版本号
@since 從什麼時候開始
@throws 抛出異常
@deprecated 過時
@category 種類
@serialData 說明通過writeObject()和writeExternal()方法寫的資料