試想一下，一個(gè)沒(méi)有一句注釋的程序源碼，怎么讀，一個(gè)程序要上萬(wàn)條代碼不可能全部記得住哪一塊是什么用，而且一個(gè)項(xiàng)目也不會(huì)是一個(gè)人獨(dú)自完成，那樣效率太低，多人合作就要給別人說(shuō)明，每一塊是什么用，方便他人使用，方便自己更正，而這些說(shuō)明文字就是注釋?zhuān)⑨尣粫?huì)被執(zhí)行，不影響運(yùn)行結(jié)果。
網(wǎng)站建設(shè)哪家好，找創(chuàng)新互聯(lián)建站！專(zhuān)注于網(wǎng)頁(yè)設(shè)計(jì)、網(wǎng)站建設(shè)、微信開(kāi)發(fā)、小程序設(shè)計(jì)、集團(tuán)企業(yè)網(wǎng)站建設(shè)等服務(wù)項(xiàng)目。為回饋新老客戶(hù)創(chuàng)新互聯(lián)還提供了濟(jì)水街道免費(fèi)建站歡迎大家使用！
Java中代碼的注釋有三種：
// 注釋一行?
/* ...... */ 注釋若干行?
/** ...... */ 注釋若干行，并寫(xiě)入 javadoc 文檔
前兩種比較容易理解，至于第三種，你學(xué)習(xí)Java看的api文檔就是javadoc程序根據(jù)第三種的注釋生成的。
擴(kuò)展資料
注釋就是對(duì)代碼的解釋和說(shuō)明，其目的是讓人們能夠更加輕松地了解代碼。注釋是編寫(xiě)程序時(shí)，寫(xiě)程序的人給一個(gè)語(yǔ)句、程序段、函數(shù)等的解釋或提示，能提高程序代碼的可讀性。
注釋符就是用來(lái)標(biāo)記注釋的符號(hào)，Java中有3種注釋符號(hào)
1. 單行注釋?zhuān)?/p>
從“//”開(kāi)始到行末結(jié)束，均視為單行注釋。
2. 多行注釋?zhuān)?/p>
從“/*”開(kāi)始到“*/”結(jié)束，均視為多行注釋。
3. 文檔注釋?zhuān)?/p>
從“/**”開(kāi)始到“*/”結(jié)束，均視為文檔注釋。
所謂文檔注釋?zhuān)侵赣胘avadoc命令可以提取為Java API文檔的注釋內(nèi)容，也就是類(lèi)的注釋和方法的注釋。
Java中沒(méi)有標(biāo)識(shí)符的概念，有標(biāo)識(shí)的概念。標(biāo)識(shí)是指包名、類(lèi)名、方法名、變量名、參數(shù)名。在你的代碼中，比如類(lèi)名 slra、方法名 main、參數(shù)名 args，這些是標(biāo)識(shí)
我看動(dòng)力節(jié)點(diǎn)的java基礎(chǔ)大全301集教中的三種注釋方法：
1、單行注釋?? //注釋的內(nèi)容
2、多行注釋??/*......*/
3、/**......*/，這種方式和第二種方式相似。這種格式是為了便于javadoc程序自動(dòng)生成文檔。
下面介紹一下Javadoc的標(biāo)記：
特別聲明：
（1）javadoc針對(duì)public類(lèi)生成注釋文檔
（2）javadoc只能在public、protected修飾的方法或者屬性之上
（3）javadoc注釋的格式化：前導(dǎo)*號(hào)和HTML標(biāo)簽
（4）javadoc注釋要僅靠在類(lèi)、屬性、方法之前
下面主要舉例說(shuō)明第三種注釋的應(yīng)用：
（1）首先編寫(xiě).java文件
（2）在命令行中執(zhí)行以下dos命令：
javadoc *.java //根據(jù)相應(yīng)的Java源代碼及其說(shuō)明語(yǔ)句生成HTML文檔
//javadoc標(biāo)記：是@開(kāi)頭的，對(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?用戶(hù)輸入?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?用戶(hù)輸入的參數(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開(kāi)始，不再建議使用此方法
*/
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用于提取源文件中的作者信息）
一、作用：1、可以大大的提高開(kāi)發(fā)效率。代碼量非常大的項(xiàng)目，在某一行中需要在后續(xù)階段實(shí)現(xiàn)一個(gè)功能，如果不標(biāo)注下次再找的時(shí)候就非常困難了。2、在團(tuán)隊(duì)合作中，還可以告訴別人某處敏感代碼的狀態(tài)。
二、以下為常見(jiàn)的兩種注釋標(biāo)記：1、// TODO： 表示在此處將要實(shí)現(xiàn)的功能，提醒你在后續(xù)階段將會(huì)在此處添加代碼
?
2、// FIXME： 表示此處的代碼邏輯有出入，或者根本不能運(yùn)行，提醒你在后續(xù)階段將會(huì)修改此處代碼
?
3、// 在Eclipse中可以自定義標(biāo)記
例如： // XXX：表示此處的代碼雖然實(shí)現(xiàn)了功能，但是性能太低，提醒你需要在后續(xù)階段優(yōu)化；
單行注釋?zhuān)?/p>
從“//”開(kāi)始到行末結(jié)束，均視為單行注釋。
多行注釋?zhuān)?/p>
從“/*”開(kāi)始到“*/”結(jié)束，均視為多行注釋。
文檔注釋?zhuān)?/p>
從“/**”開(kāi)始到“*/”結(jié)束，均視為文檔注釋。
文檔注釋與多行注釋的區(qū)別：
文檔注釋可以用javadoc命令提取出來(lái)，生成類(lèi)似于jdk文檔的網(wǎng)頁(yè)文件，以便于他人了解一個(gè)類(lèi)的功能。
這個(gè)是 java 注釋用的：
java 的三種類(lèi)型：
1、單選注釋?zhuān)悍?hào)是：//
2、塊注釋?zhuān)?符號(hào)是： /* */ 可以跨多行
3、javadoc注釋?zhuān)?符號(hào)是： /** */ 可以跨多行， 生成javadoc時(shí)，這樣的注釋會(huì)被生成標(biāo)準(zhǔn)的javaapi注釋。
重慶分公司
重慶分公司
