1 常用Java注釋標簽（Java comment tags）
@author 作者
@param 輸入參數的名稱 說明
@return 輸出參數說明
@since JDK版本
@version 版本號
@see 鏈接目標
@throws 異常
@deprecated 解釋
@link 鏈接地址
2 Java注釋的使用順序
3 簡單常見的HTML嵌入
4 HTML嵌入注釋范例
5 參考文檔
1 常用Java注釋標簽（Java comment tags）
@author 作者
適用范圍：文件、類、方法
（*多個作者使用多個@author標簽標識，java doc中顯示按輸入時間順序羅列。）
例：* @author Leo. Yao
@param 輸入參數的名稱 說明
適用范圍：方法
例：* @param str the String用來存放輸出信息。
@Param：用來在DAO層中聲明參數，如：List<News> selectByUserIdAndOffset(@Param("userId") int userId, @Param("offset") int offset, @Param("limit") int limit);
當使用了使用@Param注解來聲明參數時，如果使用 #{} 或 ${} 的方式都可以。
@Select("select entity from table where userId = ${userId} ") public int selectEntity(@Param("userId") int userId);
當不使用@Param注解來聲明參數時，必須使用使用 #{}方式。
如果使用 ${} 的方式，會報錯：
而#{}拿到值之后，拼裝sql，會自動對值添加引號${}則把拿到的值直接拼裝進sql，如果需要加單引號，必須手動添加，一般用於動態傳入表名或字段名使用，#{}傳參能防止sql注入
@return 輸出參數說明
適用范圍：方法
例： * @return <code>true</code>執行成功;
* <code>false</code>執行失敗.
@since JDK版本
用於標識編譯該文件所需要的JDK環境。
適用范圍：文件、類
例： * @since JDK1.6
@version 版本號
用於標識注釋對象的版本號
適用范圍：文件、類、方法
例： * @version 1.0
@see 鏈接目標
表示參考。會在java 文檔中生成一個超鏈接，鏈接到參考的類容。使用中的感覺是@see不需要包路徑，對我這種懶人比較喜歡，相對{@link }這種既要加大括號，有需要包路徑，我還是選擇偷懶，當然你要是不介意使用import導入要link的類，那就可以達到@see的效果，所以總體來說，還是選擇@see，當然兩個在特殊場合下還是用法不一樣的
用法：
@see #field
@see #Constructor(Type, Type...)
@see #Constructor(Type id, Type id...)
@see #method(Type, Type,...)
@see #method(Type id, Type, id...)
@see Class
@see Class#field
@see Class#Constructor(Type, Type...)
@see Class#Constructor(Type id, Type id)
@see Class#method(Type, Type,...)
@see Class#method(Type id, Type id,...)
@see package.Class
@see package.Class#field
@see package.Class#Constructor(Type, Type...)
@see package.Class#Constructor(Type id, Type id)
@see package.Class#method(Type, Type,...)
@see package.Class#method(Type id, Type, id)
@see package
@throws 異常
標識出方法可能拋出的異常
適用范圍：方法
例： * @throws IOException If an input or output exception occurred
@deprecated 解釋
標識對象過期
適用范圍：文件、類、方法
@link 鏈接地址
鏈接到一個目標，用法類似@see。但常放在注釋的解釋中形如{@link …}
例：
/**
* @deprecated As of JDK 1.1, replaced by
* {@link #setBounds(int,int,int,int)}
*/
2 Java注釋的使用順序
* @author (classes and interfaces only, required)
* @version (classes and interfaces only, required. See footnote 1)
* @param (methods and constructors only)
* @return (methods only)
* @exception (@throws is a synonym added in Javadoc 1.2)
* @see
* @since
* @serial (or @serialField or @serialData)
* @deprecated (see How and When To Deprecate APIs)
3 簡單常見的HTML嵌入
<P> 用於分段
<code> 標簽用於表示計算機源代碼或者其他機器可以閱讀的文本內容。<code> 標簽就是為軟件代碼的編寫者設計的。包含在該標簽內的文本將用等寬、類似電傳打字機樣式的字體（Courier）顯示出來只應該在表示計算機程序源代碼或者其他機器可以閱讀的文本內容上使用 <code> 標簽。雖然<code> 標簽通常只是把文本變成等寬字體，但它暗示着這段文本是源程序代碼。將來的瀏覽器有可能會加入其他顯示效果。例如，程序員的瀏覽器可能會尋找 <code> 片段，並執行某些額外的文本格式化處理，如循環和條件判斷語句的特殊縮進等。