對于開發(fā)的朋友來說，每次寫類文件前面寫注釋文件未免有些重復。下面我們可以利用代碼模板快速創(chuàng)建常見的注釋文件。 查看默認狀態(tài) 新建類文件時，默認是不生成注釋的?？梢酝ㄟ^以下步驟進行設置：

對于開發(fā)的朋友來說，每次寫類文件前面寫注釋文件未免有些重復。下面我們可以利用代碼模板快速創(chuàng)建常見的注釋文件。

查看默認狀態(tài)

新建類文件時，默認是不生成注釋的。可以通過以下步驟進行設置：

1. 在Windows菜單欄選擇“Preferences”
2. 選擇“Java” - “Code Style” - “Code Templates”
3. 編輯文件為7的樣式（為了方便起見，中間插入截圖說明，熟悉的朋友可以直接跳到步驟7）
4. 對于中文版本，選擇“窗口” - “首選項” - “Java” - “代碼樣式” - “代碼模板” - “新的Java文件”
5. 找到“菜單欄”、“窗口” - “首選項”
6. 選擇“Java” - “代碼樣式” - “注釋” - “新生成的Java文件”
7. 直接編輯配置文件，在配置文件中添加注釋代碼。這部分可以自定義，參考如下：

------------------我是分割線，別復制我-----------------------------------
${filecomment}${package_declaration}/
 * @author 作者 E-mail:
 * @date 創(chuàng)建時間：${date} ${time}
 * @version 1.0
 * @parameter 
 * @since  
 * @return  
 */
${typecomment}${type_declaration}
------------------我是分割線，別復制我-----------------------------------

新建文件將自動生成注釋

現在新建文件時，就會自動生成注釋。

Javadoc簡介

Javadoc是Sun公司提供的一個技術，它可以從程序源代碼中抽取類、方法、成員等注釋，形成與源代碼配套的API幫助文檔。也就是說，只要在編寫程序時使用特定的標簽進行注釋，在程序編寫完成后，通過Javadoc就可以同時生成程序的開發(fā)文檔。

Javadoc關鍵詞列表

以下是一些常用的Javadoc關鍵詞：

• @author 作者名
• @date 日期
• @version 版本標識
• @parameter 參數及其意義
• @since 最早使用該方法/類/接口的JDK版本
• @return 返回值
• @throws 異常類及拋出條件
• @deprecated 引起不推薦使用的警告
• @see reference 查看引用
• @override 重寫

更多Javadoc的用法可以參考百度百科或官方文檔。

結語

感謝你的閱讀，希望這篇文章對你有所幫助。后續(xù)我會繼續(xù)分享類注釋、字段注釋和方法注釋的相關內容。