Myeclipse 中的注釋

        注釋也是一門藝術,好的注釋不僅便于后期維護,還可以生成接口文檔便于前端查閱。
        有必要的話可以將自己的注釋寫成一個模板,以后用的時候直接復制就行。
關于在myeclipse中如何設置注釋模板,請參考:https://blog.csdn.net/u012463017/article/details/52189802
文檔注釋中是支持html標簽的 所以可以定制自己的模板。
下面是我目前用注釋模板：

/*
<p><b>描述：</b></p>
<p></p>

<p><b>用途：</b> </p>
<p></p>

• @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>
  */
  

這個模板顯示效果如上圖，注釋寫完直接導出成javadoc文檔留存。
雖然注釋寫起來比較麻煩費時，但是我相信完整的注釋不僅會對項目后期有很大作用，對于后期自己維護，或者別人維護的時候都是一件有意義的事情。
當然方法內的其他注釋也是不能少的。

// 這是單行注釋
    /*
*
**這是多行注釋
*
*/

        /**
        *這是文檔注釋
        */
        注釋關鍵字：
                        @author   作者
                        @param  參數
                        @return  返回值
                        @exception  異常
                        @see  引用其他類
                        @version  版本號
                        @since  從什么時候開始
                        @throws 拋出異常
                        @deprecated 過時
                        @category 種類
                        @serialData 說明通過writeObject()和writeExternal()方法寫的數據

好記性不如爛筆頭,趁著還記得住,寫下備用.