我看動(dòng)力節(jié)點(diǎn)的java基礎(chǔ)大全301集教中的三種注釋方法：
我們注重客戶提出的每個(gè)要求，我們充分考慮每一個(gè)細(xì)節(jié)，我們積極的做好做網(wǎng)站、成都網(wǎng)站建設(shè)服務(wù)，我們努力開拓更好的視野，通過不懈的努力，成都創(chuàng)新互聯(lián)公司贏得了業(yè)內(nèi)的良好聲譽(yù)，這一切，也不斷的激勵(lì)著我們更好的服務(wù)客戶。 主要業(yè)務(wù)：網(wǎng)站建設(shè),網(wǎng)站制作,網(wǎng)站設(shè)計(jì),小程序開發(fā),網(wǎng)站開發(fā),技術(shù)開發(fā)實(shí)力，DIV+CSS，PHP及ASP，ASP.Net，SQL數(shù)據(jù)庫的技術(shù)開發(fā)工程師。
1、單行注釋?? //注釋的內(nèi)容
2、多行注釋??/*......*/
3、/**......*/，這種方式和第二種方式相似。這種格式是為了便于javadoc程序自動(dòng)生成文檔。
下面介紹一下Javadoc的標(biāo)記：
特別聲明：
（1）javadoc針對(duì)public類生成注釋文檔
（2）javadoc只能在public、protected修飾的方法或者屬性之上
（3）javadoc注釋的格式化：前導(dǎo)*號(hào)和HTML標(biāo)簽
（4）javadoc注釋要僅靠在類、屬性、方法之前
下面主要舉例說明第三種注釋的應(yīng)用：
（1）首先編寫.java文件
（2）在命令行中執(zhí)行以下dos命令：
javadoc *.java //根據(jù)相應(yīng)的Java源代碼及其說明語句生成HTML文檔
//javadoc標(biāo)記：是@開頭的，對(duì)javadoc而言，特殊的標(biāo)記。
（3）在當(dāng)前目錄下就會(huì)產(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個(gè)方法,其作用是...*/
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鏈接到另一個(gè)文檔{@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);
}
/**這是第一個(gè)方法，其作用是....
*@deprecated?從版本1.2開始，不再建議使用此方法
*/
public?static?void?f1(){
System.out.println("fl()!");
}
/**這是第二個(gè)方法，其作用是....
*@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標(biāo)記，則在執(zhí)行javadoc命令時(shí)，要加-version?-author
javadoc?-version?-author?-d?doc?*.java
（其中用-version用于提取源文件中的版本信息?-author用于提取源文件中的作者信息）
ResourceBundle res;
//打開對(duì)應(yīng)的db.prop屬性文件文件，和你的java class同一目錄下
res = ResourceBundle.getBundle("db");
//從文件中取得ulr, user, password, jdbc driver名字
String url=res.getString("url");
String user=res.getString("user");
String password=res.getString("password");
String className = res.getString("classname");
try{
//初始化你的jdbc dirver
Class.forName(className).newInstance();
//建立connection
conn = DriverManager.getConnection(url,user,password);
}catch(Exception e)
{
e.printStackTrace();
}
return conn;
1、單行(single-line)--短注釋：//……
單獨(dú)行注釋：在代碼中單起一行注釋，
注釋前最好有一行空行，并與其后的代碼具有一樣的縮進(jìn)層級(jí)。如果單行無法完成，則應(yīng)采用塊注釋。
注釋格式：/*
注釋內(nèi)容
*/
行頭注釋：在代碼行的開頭進(jìn)行注釋。主要為了使該行代碼失去意義。
注釋格式：//
注釋內(nèi)容
行尾注釋：尾端(trailing)--極短的注釋，在代碼行的行尾進(jìn)行注釋。一般與代碼行后空8（至少4）個(gè)格，所有注釋必須對(duì)齊。
注釋格式：代碼
+
8（至少4）個(gè)空格
+
//
注釋內(nèi)容
2、塊(block)--塊注釋：/*……*/
注釋若干行，通常用于提供文件、方法、數(shù)據(jù)結(jié)構(gòu)等的意義與用途的說明，或者算法的描述。一般位于一個(gè)文件或者一個(gè)方法的前面，起到引導(dǎo)的作用，也可以根據(jù)需要放在合適的位置。這種域注釋不會(huì)出現(xiàn)在HTML報(bào)告中。注釋格式通常寫成：
/*
*
注釋內(nèi)容
*/
3、文檔注釋：/**……*/
注釋若干行，并寫入javadoc文檔。每個(gè)文檔注釋都會(huì)被置于注釋定界符
/**......*/
...
Java中三種類型的注釋：
單行注釋：// 注釋內(nèi)容
多行注釋：/*... 注釋內(nèi)容....*/
文本注釋：/**.. 注釋內(nèi)容....*/
代碼注釋是架起程序設(shè)計(jì)者與程序閱讀者之間的通信橋梁，最大限度的提高團(tuán)隊(duì)開發(fā)合作效率。也是程序代碼可維護(hù)性的重要環(huán)節(jié)之一。所以不是為寫注釋而寫注釋。
備注：簡(jiǎn)單的代碼做簡(jiǎn)單注釋，注釋內(nèi)容不大于10個(gè)字即可，另外，持久化對(duì)象或VO對(duì)象的getter、setter方法不需加注釋。
擴(kuò)展資料：
類（模塊）注釋采用 /** …… */，在每個(gè)類（模塊）的頭部要有必要的注釋信息，包括：工程名；類（模塊）編號(hào)；命名空間；類可以運(yùn)行的JDK版本；版本號(hào)；作者；創(chuàng)建時(shí)間；類（模塊）功能描述（如功能、主要算法、內(nèi)部各部分之間的關(guān)系、該類與其類的關(guān)系等，必要時(shí)還要有一些如特別的軟硬件要求等說明）；主要函數(shù)或過程清單及本類（模塊）歷史修改記錄等。
參考資料來源：百度百科-java注釋
1、【文檔注釋】是寫在類或者方法的上面的。
文檔注釋可以用eclipse導(dǎo)出chm格式的幫助文檔，拿給其他人用時(shí)，方便他人理解。文檔注釋被調(diào)用的方法，當(dāng)鼠標(biāo)移到上面時(shí)提醒注釋內(nèi)容。
使用文檔注釋時(shí)，需要在開始的?/**?之后，第一行或幾行是關(guān)于類、變量和方法的主要描述。
之后，可以包含一個(gè)或多個(gè)何種各樣的@?標(biāo)簽。每一個(gè)@標(biāo)簽必須在一個(gè)新行的開始或者在一行的開始緊跟星號(hào)(*)。多個(gè)相同類型的標(biāo)簽應(yīng)該放成一組。
2、【多行注釋】注釋的也是方法或類，言下之意就是一次性的將程序中的多行代碼注釋掉，但多行注釋的內(nèi)容不能用于生成一個(gè)開發(fā)者文檔。
3、【多行注釋與文檔注釋的區(qū)別】多行注釋的內(nèi)容不能用于生成一個(gè)開發(fā)者文檔，而文檔注釋 的內(nèi)容可以生產(chǎn)一個(gè)開發(fā)者文檔。
擴(kuò)展資料
java常用的文檔注釋標(biāo)簽
1、@author：標(biāo)識(shí)一個(gè)類的作者
實(shí)例：?@author description
2、@deprecated：指名一個(gè)過期的類或成員
實(shí)例：?@deprecated description
3、@exception：標(biāo)志一個(gè)類拋出的異常
實(shí)例：@exception exception-name explanation
4、{@inheritDoc}：從直接父類繼承的注釋
實(shí)例：Inherits a comment from the immediate surperclass.
5、{@link}：插入一個(gè)到另一個(gè)主題的鏈接
實(shí)例：{@link name text}
6、{@linkplain}：插入一個(gè)到另一個(gè)主題的鏈接，但是該鏈接顯示純文本字體
實(shí)例：Inserts an in-line link to another topic.
7、@param：說明一個(gè)方法的參數(shù)
實(shí)例：@param parameter-name explanation
8、@return：說明返回值類型
實(shí)例：@return explanation
9、@see：指定一個(gè)到另一個(gè)主題的鏈接
實(shí)例：@see anchor
10、@serial：說明一個(gè)序列化屬性
實(shí)例：@serial description
參考資料：百度百科-java注釋
重慶分公司
重慶分公司
