在Eclipse中設(shè)置自動(dòng)生成注釋
對(duì)于開(kāi)發(fā)的朋友來(lái)說(shuō)，每次寫(xiě)類文件前面寫(xiě)注釋文件未免有些重復(fù)。下面我們可以利用代碼模板快速創(chuàng)建常見(jiàn)的注釋文件。 查看默認(rèn)狀態(tài) 新建類文件時(shí)，默認(rèn)是不生成注釋的?？梢酝ㄟ^(guò)以下步驟進(jìn)行設(shè)置：
對(duì)于開(kāi)發(fā)的朋友來(lái)說(shuō)，每次寫(xiě)類文件前面寫(xiě)注釋文件未免有些重復(fù)。下面我們可以利用代碼模板快速創(chuàng)建常見(jiàn)的注釋文件。
查看默認(rèn)狀態(tài)
新建類文件時(shí)，默認(rèn)是不生成注釋的?？梢酝ㄟ^(guò)以下步驟進(jìn)行設(shè)置：
- 在Windows菜單欄選擇“Preferences”
- 選擇“Java” - “Code Style” - “Code Templates”
- 編輯文件為7的樣式（為了方便起見(jiàn)，中間插入截圖說(shuō)明，熟悉的朋友可以直接跳到步驟7）
- 對(duì)于中文版本，選擇“窗口” - “首選項(xiàng)” - “Java” - “代碼樣式” - “代碼模板” - “新的Java文件”
- 找到“菜單欄”、“窗口” - “首選項(xiàng)”
- 選擇“Java” - “代碼樣式” - “注釋” - “新生成的Java文件”
- 直接編輯配置文件，在配置文件中添加注釋代碼。這部分可以自定義，參考如下：
------------------我是分割線，別復(fù)制我-----------------------------------
${filecomment}${package_declaration}/
* @author 作者 E-mail:
* @date 創(chuàng)建時(shí)間：${date} ${time}
* @version 1.0
* @parameter
* @since
* @return
*/
${typecomment}${type_declaration}
------------------我是分割線，別復(fù)制我-----------------------------------新建文件將自動(dòng)生成注釋
現(xiàn)在新建文件時(shí)，就會(huì)自動(dòng)生成注釋。
Javadoc簡(jiǎn)介
Javadoc是Sun公司提供的一個(gè)技術(shù)，它可以從程序源代碼中抽取類、方法、成員等注釋，形成與源代碼配套的API幫助文檔。也就是說(shuō)，只要在編寫(xiě)程序時(shí)使用特定的標(biāo)簽進(jìn)行注釋，在程序編寫(xiě)完成后，通過(guò)Javadoc就可以同時(shí)生成程序的開(kāi)發(fā)文檔。
Javadoc關(guān)鍵詞列表
以下是一些常用的Javadoc關(guān)鍵詞：
- @author 作者名
- @date 日期
- @version 版本標(biāo)識(shí)
- @parameter 參數(shù)及其意義
- @since 最早使用該方法/類/接口的JDK版本
- @return 返回值
- @throws 異常類及拋出條件
- @deprecated 引起不推薦使用的警告
- @see reference 查看引用
- @override 重寫(xiě)
更多Javadoc的用法可以參考百度百科或官方文檔。
結(jié)語(yǔ)
感謝你的閱讀，希望這篇文章對(duì)你有所幫助。后續(xù)我會(huì)繼續(xù)分享類注釋、字段注釋和方法注釋的相關(guān)內(nèi)容。