什么是注釋？如何在Java程序中加入注釋？

試想一下，一個(gè)沒(méi)有一句注釋的程序源碼，怎么讀，一個(gè)程序要上萬(wàn)條代碼不可能全部記得住哪一塊是什么用，而且一個(gè)項(xiàng)目也不會(huì)是一個(gè)人獨(dú)自完成，那樣效率太低，多人合作就要給別人說(shuō)明，每一塊是什么用，方便他人使用，方便自己更正，而這些說(shuō)明文字就是注釋，注釋不會(huì)被執(zhí)行，不影響運(yùn)行結(jié)果。

10年積累的成都網(wǎng)站建設(shè)、網(wǎng)站設(shè)計(jì)經(jīng)驗(yàn)，可以快速應(yīng)對(duì)客戶對(duì)網(wǎng)站的新想法和需求。提供各種問(wèn)題對(duì)應(yīng)的解決方案。讓選擇我們的客戶得到更好、更有力的網(wǎng)絡(luò)服務(wù)。我雖然不認(rèn)識(shí)你，你也不認(rèn)識(shí)我。但先網(wǎng)站制作后付款的網(wǎng)站建設(shè)流程，更有三元免費(fèi)網(wǎng)站建設(shè)讓你可以放心的選擇與我們合作。

Java中代碼的注釋有三種：

// 注釋一行?

/* ...... */ 注釋若干行?

/** ...... */ 注釋若干行，并寫入 javadoc 文檔

前兩種比較容易理解，至于第三種，你學(xué)習(xí)Java看的api文檔就是javadoc程序根據(jù)第三種的注釋生成的。

擴(kuò)展資料

注釋就是對(duì)代碼的解釋和說(shuō)明，其目的是讓人們能夠更加輕松地了解代碼。注釋是編寫程序時(shí)，寫程序的人給一個(gè)語(yǔ)句、程序段、函數(shù)等的解釋或提示，能提高程序代碼的可讀性。

java中的注釋可分為三種類型

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í)還要有一些如特別的軟硬件要求等說(shuō)明）；主要函數(shù)或過(guò)程清單及本類（模塊）歷史修改記錄等。

參考資料來(lái)源：百度百科-java注釋

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注釋要僅靠在類、屬性、方法之前

下面主要舉例說(shuō)明第三種注釋的應(yīng)用：

（1）首先編寫.java文件

（2）在命令行中執(zhí)行以下dos命令：

javadoc *.java //根據(jù)相應(yīng)的Java源代碼及其說(shuō)明語(yǔ)句生成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用于提取源文件中的作者信息）

網(wǎng)站標(biāo)題：java代碼的注釋,java代碼的注釋率應(yīng)當(dāng)達(dá)到多少
分享路徑：http://chinadenli.net/article17/dseghgj.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供Google、標(biāo)簽優(yōu)化、外貿(mào)建站、全網(wǎng)營(yíng)銷推廣、搜索引擎優(yōu)化、網(wǎng)站制作

廣告

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