java 怎樣給源代碼添加注釋

1、單行(single-line)--短注釋：//……

成都創(chuàng)新互聯(lián)公司-成都網(wǎng)站建設(shè)公司，專注成都網(wǎng)站設(shè)計(jì)、網(wǎng)站制作、網(wǎng)站營銷推廣，申請(qǐng)域名，虛擬空間，網(wǎng)站運(yùn)營有關(guān)企業(yè)網(wǎng)站制作方案、改版、費(fèi)用等問題，請(qǐng)聯(lián)系成都創(chuàng)新互聯(lián)公司。

單獨(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 中的幾種注釋方式

我看動(dòng)力節(jié)點(diǎn)的java基礎(chǔ)大全301集教中的三種注釋方法：

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用于提取源文件中的作者信息）

可以幫我把一些JAVA代碼加注釋嗎？ 方便我可以看得懂，理解的到，謝謝了。

java代碼注釋快捷鍵：ctrl+shift+/

首先熟悉一下html、css、js的注釋的寫法：

1、HTML注釋語法：

!--注釋的內(nèi)容--

2、css注釋語法

/* 注釋內(nèi)容 */

/* ----------文字樣式開始---------- */

3、javaScript注釋

//注釋內(nèi)容

/*注釋內(nèi)容*/

接下來是對(duì)注釋在這幾種代碼中使用的位置，如何寫注釋進(jìn)行總結(jié)一下。（根據(jù)個(gè)人的習(xí)慣可能不一樣）

新聞名稱：java代碼注釋語法,java的注釋語句
網(wǎng)頁URL：http://chinadenli.net/article20/heeojo.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供靜態(tài)網(wǎng)站、云服務(wù)器、手機(jī)網(wǎng)站建設(shè)、網(wǎng)站改版、軟件開發(fā)、App開發(fā)

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來源： 創(chuàng)新互聯(lián)