(1)單行注釋:以“ // ”開頭后面接所要加的說明的內(nèi)容。如下面所示: //定義變量a int a = 10; //定義變量b int b = 20;上面的語句中,在編譯的過程就會(huì)直接略過注釋,只會(huì)編譯 int a = 10 和 int b = 20這兩句。由此可見注釋只是起著說明的作用。
創(chuàng)新互聯(lián)建站堅(jiān)持“要么做到,要么別承諾”的工作理念,服務(wù)領(lǐng)域包括:成都做網(wǎng)站、網(wǎng)站建設(shè)、企業(yè)官網(wǎng)、英文網(wǎng)站、手機(jī)端網(wǎng)站、網(wǎng)站推廣等服務(wù),滿足客戶于互聯(lián)網(wǎng)時(shí)代的個(gè)舊網(wǎng)站設(shè)計(jì)、移動(dòng)媒體設(shè)計(jì)的需求,幫助企業(yè)找到有效的互聯(lián)網(wǎng)解決方案。努力成為您成熟可靠的網(wǎng)絡(luò)建設(shè)合作伙伴!
(2)多行注釋:以“/*”開頭,以“*/”結(jié)尾。 假設(shè)當(dāng)你要說明你所寫的代碼的功能時(shí)。要說明的內(nèi)容有很多。如果全部放在同一行會(huì)顯得很難看。所以一般會(huì)用多行來寫,如下所示// 說明//說明//說明//說明以上是用四個(gè)單行注釋來注釋四行說明。但如果有10行說明就要按十個(gè)“//”這顯示很麻煩,所以這時(shí)就可采用多行注釋。上面的可改成:/*說明說明說明說明*/也可以這樣/* 說明 說明 說明 說明 */
(3)文檔注釋:以“/**”開頭,以“*/”結(jié)尾。文檔注釋主要是生成文檔的。
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í)例:?@authordescription
2、@deprecated:指名一個(gè)過期的類或成員
實(shí)例:?@deprecateddescription
3、@exception:標(biāo)志一個(gè)類拋出的異常
實(shí)例:@exceptionexception-nameexplanation
4、{@inheritDoc}:從直接父類繼承的注釋
實(shí)例:Inheritsacommentfromtheimmediatesurperclass.
5、{@link}:插入一個(gè)到另一個(gè)主題的鏈接
實(shí)例:{@linknametext}
6、{@linkplain}:插入一個(gè)到另一個(gè)主題的鏈接,但是該鏈接顯示純文本字體
實(shí)例:Insertsanin-linelinktoanothertopic.
7、@param:說明一個(gè)方法的參數(shù)
實(shí)例:@paramparameter-nameexplanation
8、@return:說明返回值類型
實(shí)例:@returnexplanation
9、@see:指定一個(gè)到另一個(gè)主題的鏈接
實(shí)例:@seeanchor
10、@serial:說明一個(gè)序列化屬性
實(shí)例:@serialdescription
參考資料:百度百科-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用于提取源文件中的作者信息)
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ì)被置于注釋定界符 /**......*/ ...
本文標(biāo)題:java代碼文檔注釋 java文檔注釋的符號(hào)怎么打
URL分享:http://sd-ha.com/article40/ddsipeo.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供動(dòng)態(tài)網(wǎng)站、App設(shè)計(jì)、企業(yè)網(wǎng)站制作、網(wǎng)站建設(shè)、關(guān)鍵詞優(yōu)化、企業(yè)建站
聲明:本網(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í)需注明來源: 創(chuàng)新互聯(lián)