單行註釋、多行註釋、文件註釋最完美的解釋、匯出API
阿新 • • 發佈：2019-02-05
註釋是程式開發人員和程式閱讀者之間交流的手段，對程式碼的解釋和說明，提高軟體的可讀性，有利於程式應用的維護。
1、單行註釋
只對一行程式碼註釋，例如 //單行註釋，以‘//’開頭，跟在‘//’後面的文字就是註釋內容。單行註釋不會被編譯，不要把程式碼寫在‘//’的後面。
快捷鍵：ctrl+/
2、多行註釋
當多行內容要被註釋時，選擇多行註釋。例如 /*多行註釋*/
快捷鍵：選中要註釋的內容，按ctrl+shift+/ ,也可以輸入 /* 後按enter鍵即可。
3、多行註釋
格式：/**
* 走路方法
*/
快捷鍵：在myeclipse的類中的內容頂部輸入 /** 後按enter鍵即可。
如果想匯出幫助文件API檔案，那麼就可以在方法或類的前面使用文件註釋，使用安裝jdk的javadoc命令把程式碼文件註釋的部分提取出來，自動生成HTML格式的API幫助文件。可以使用myeclipse匯出整個專案的幫助文件，也可以匯出單個類或介面的API。文件註釋還有一個好處是被呼叫的方法，當滑鼠移到上面時提醒註釋內容。
常用的文件註釋標籤：
| 標籤 | 描述 | 示例 |
|---|---|---|
| @author | 標識一個類的作者 | @author description |
| @deprecated | 指名一個過期的類或成員 | @deprecated description |
| {@docRoot} |
指明當前文件根目錄的路徑 |
Directory Path |
| @exception | 標誌一個類丟擲的異常 | @exception exception-name explanation |
| {@inheritDoc} | 從直接父類繼承的註釋 | Inherits a comment from the immediate surperclass. |
| {@link} | 插入一個到另一個主題的連結 | {@link name text} |
| {@linkplain} | 插入一個到另一個主題的連結，但是該連結顯示純文字字型 | Inserts an in-line link to another topic. |
| @param |
說明一個方法的引數 |
@param parameter-name explanation |
| @return | 說明返回值型別 | @return explanation |
| @see | 指定一個到另一個主題的連結 | @see anchor |
| @serial | 說明一個序列化屬性 | @serial description |
| @serialData | 說明通過writeObject( ) 和 writeExternal( )方法寫的資料 | @serialData description |
| @serialField | 說明一個ObjectStreamField元件 | @serialField name type description |
| @since | 標記當引入一個特定的變化時 | @since release |
| @throws | 和 @exception標籤一樣. | The @throws tag has the same meaning as the @exception tag. |
| {@value} | 顯示常量的值，該常量必須是static屬性。 | Displays the value of a constant, which must be a static field. |
| @version | 指定類的版本 |
@version info |