eclipse設(shè)置創(chuàng)建一個java文件后自動加入注釋的方法:
公司主營業(yè)務(wù):成都做網(wǎng)站、網(wǎng)站設(shè)計、移動網(wǎng)站開發(fā)等業(yè)務(wù)。幫助企業(yè)客戶真正實現(xiàn)互聯(lián)網(wǎng)宣傳,提高企業(yè)的競爭能力。成都創(chuàng)新互聯(lián)是一支青春激揚、勤奮敬業(yè)、活力青春激揚、勤奮敬業(yè)、活力澎湃、和諧高效的團隊。公司秉承以“開放、自由、嚴謹、自律”為核心的企業(yè)文化,感謝他們對我們的高要求,感謝他們從不同領(lǐng)域給我們帶來的挑戰(zhàn),讓我們激情的團隊有機會用頭腦與智慧不斷的給客戶帶來驚喜。成都創(chuàng)新互聯(lián)推出新干免費做網(wǎng)站回饋大家。
1、通過菜單 Window-Preference 打開參數(shù)設(shè)置面板,然后選擇:
Java - Code Style - Code ?Templates
2、在右側(cè)選擇Comments,將其中的Files項,然后選右邊的"Edit",進入編輯模式: ??
3、進入編輯模式后就可以自定義注釋了。另外可以插入一些變量,如年、日期等等。
4、最后,確保 Code - New Java files 中有:"${filecomment}"
先看默認狀態(tài)的吧,新建類文件時,是不生成注釋的
在
windows--preferenceJava--Code Style--Code Templatescode--new Java file
編輯文件為7的樣式,(為了方便起見,中間分布截圖說明,熟悉的朋友直接跳到7)
對于中文版本
窗口--首選項
java--代碼樣式--代碼模板
代碼--新的java文件
菜單欄,窗口——首選項
找到j(luò)ava選項--代碼樣式
注釋--新生成的java文件
直接編輯配置文件
在配置文件中間添加注釋代碼,這部分可以自定義,參考如下,關(guān)鍵字解釋見后文10
------------------我是分割線,別復(fù)制我-----------------------------------
${filecomment}${package_declaration}/** * @author 作者 E-mail: * @date 創(chuàng)建時間:${date} ${time} * @version 1.0 * @parameter * @since * @return */${typecomment}${type_declaration}
------------------我是分割線,別復(fù)制我-----------------------------------
現(xiàn)在新建文件將自動生成注釋
補充說明;
也許你看到我們在寫注釋文件時用到了很多關(guān)鍵字,那么這里我們就了解一下Javadoc
Javadoc是Sun公司提供的一個技術(shù),它從程序源代碼中抽取類、方法、成員等注釋形成一個和源代碼配套的API幫助文檔。也就是說,只要在編寫程序時以一套特定的標簽作注釋,在程序編寫完成后,通過Javadoc就可以同時形成程序的開發(fā)文檔了
關(guān)鍵詞列表:
@author 作者名
@date 日期
@version 版本標識
@parameter 參數(shù)及其意義
@since 最早使用該方法/類/接口的JDK版本
@return 返回值
@throws 異常類及拋出條件
@deprecated 引起不推薦使用的警告
@see reference 查看引用
@override 重寫
更多Javadoc用法可以訪問:百度百科、官方文檔。
我看動力節(jié)點的java基礎(chǔ)大全301集教中的三種注釋方法:
1、單行注釋?? //注釋的內(nèi)容
2、多行注釋??/*......*/
3、/**......*/,這種方式和第二種方式相似。這種格式是為了便于javadoc程序自動生成文檔。
下面介紹一下Javadoc的標記:
特別聲明:
(1)javadoc針對public類生成注釋文檔
(2)javadoc只能在public、protected修飾的方法或者屬性之上
(3)javadoc注釋的格式化:前導(dǎo)*號和HTML標簽
(4)javadoc注釋要僅靠在類、屬性、方法之前
下面主要舉例說明第三種注釋的應(yīng)用:
(1)首先編寫.java文件
(2)在命令行中執(zhí)行以下dos命令:
javadoc *.java //根據(jù)相應(yīng)的Java源代碼及其說明語句生成HTML文檔
//javadoc標記:是@開頭的,對javadoc而言,特殊的標記。
(3)在當前目錄下就會產(chǎn)生doc文件夾,里面有一系列的.html文件
附上代碼:
[java]?view plain?copy
span?style="font-size:18px;"*/
/**javadoc注釋的內(nèi)容
*/
public?class?Hello{
/**屬性上的注釋*/
public?String?name;
/**這是main方法,是程序的入口
*@param?args?用戶輸入?yún)?shù)
*/
public?static?void?main(String[]?args){
System.out.println("Hello?World!");
f1();
}
/**?這是第1個方法,其作用是...*/
public?static?void?f1(){
System.out.println("f1()!");
}
}/span
[java]?view plain?copy
span?style="font-size:18px;"import?java.io.IOException;
/**javadoc注釋內(nèi)容
*@since?1.0
*@version?1.1
*@author?Blue?Jey
*br鏈接到另一個文檔{@link?Hello},就這些
*see?Hello
*/
public?class?HelloWorld{
/**非public,protected?屬性上的注釋不生成*/
public?String?name;
/**這是main方法,是程序的入口
*@param?args?用戶輸入的參數(shù),是數(shù)組
*@throws?IOException?main方法io異常
*/
public?static?void?main(String?args[])?throws?IOException{
System.out.println("hello?World!");
f1();
f2(1);
}
/**這是第一個方法,其作用是....
*@deprecated?從版本1.2開始,不再建議使用此方法
*/
public?static?void?f1(){
System.out.println("fl()!");
}
/**這是第二個方法,其作用是....
*@return?返回是否OK
*@param?i?輸入?yún)?shù)i
*@see?Hello
*@throws?IOException?io異常
*/
public?static?String?f2(int?i)throws?IOException{
System.out.println("f1()!");
return?"OK";
}
}?/span
注意:
如果源文件中有用到@version,@author標記,則在執(zhí)行javadoc命令時,要加-version?-author
javadoc?-version?-author?-d?doc?*.java
(其中用-version用于提取源文件中的版本信息?-author用于提取源文件中的作者信息)