java代碼注釋一般格式 java中代碼注釋有哪些

java注釋若干行的格式

注釋：//表示注釋一行。

創(chuàng)新互聯(lián)建站是一家專注于網(wǎng)站設(shè)計、做網(wǎng)站與策劃設(shè)計,洮北網(wǎng)站建設(shè)哪家好?創(chuàng)新互聯(lián)建站做網(wǎng)站,專注于網(wǎng)站建設(shè)十年,網(wǎng)設(shè)計領(lǐng)域的專業(yè)建站公司;建站業(yè)務(wù)涵蓋:洮北等地區(qū)。洮北做網(wǎng)站價格咨詢:18980820575

/*表示注釋段內(nèi)容（可以為很多行）*/

public static void main(String [] args){

System.out.println("Hello World1");

//System.out.println("Hello World2");

System.out.println("Hello World3");

/*System.out.println("Hello World4");

System.out.println("Hello World5");/*

}

這樣的話就只會輸出：

Hello World 1

Hello World 3

這樣很好理解吧？

想編寫優(yōu)美的java代碼格式要記住這幾條規(guī)則

做到這些規(guī)則的目的很簡單，就是寫出“優(yōu)美”的Java代碼來。

1、Java注釋盡可能全面

對于方法的注釋應(yīng)該包含詳細(xì)的入?yún)⒑徒Y(jié)果說明，有異常拋出的情況也要詳細(xì)敘述：類的注釋應(yīng)該包含類的功能說明、作者和修改者。

2、多次使用的相同變量最好歸納成常量 多處使用的相同值的變量應(yīng)該盡量歸納為一個常量，方便日后的維護。

3、盡量少的在循環(huán)中執(zhí)行方法調(diào)用 盡量在循環(huán)中少做一些可避免的方法調(diào)用，這樣可以節(jié)省方法棧的創(chuàng)建。例如：

for（int i=0;ilist.size（）；i++）{

System.out.println（i）；}可以修改為：

for（int i=0,size=list.size（）；isize;i++）{

System.out.println（i）；}4、常量的定義可以放到接口中 在Java培訓(xùn)中，接口里只允許存在常量，因此把常量放到接口中聲明就可以省去public static final這幾個關(guān)鍵詞。

5、ArrayList和LinkedList的選擇 這個問題比較常見。通常程序員最好能夠?qū)ist的使用場景做出評估，然后根據(jù)特性作出選擇。ArrayList底層是使用數(shù)組實現(xiàn)的，因此隨機讀取數(shù)據(jù) 會比LinkedList快很多，而LinkedList是使用鏈表實現(xiàn)的，新增和刪除數(shù)據(jù)的速度比ArrayList快不少。

6、String,StringBuffer和StringBuilder 這個問題也比較常見。在進行字符串拼接處理的時候，String通常會產(chǎn)生多個對象，而且將多個值緩存到常量池中。例如：

String a=“a”;

String b=“b”;a=a+b;這種情況下jvm會產(chǎn)生“a”,“b”,“ab”三個對象。而且字符串拼接的性能也很低。因此通常需要做字符串處理的時候盡量采用StringBuffer和StringBuilder來。

7、包裝類和基本類型的選擇 在代碼中，如果可以使用基本數(shù)據(jù)類型來做局部變量類型的話盡量使用基本數(shù)據(jù)類型，因為基本類型的變量是存放在棧中的，包裝類的變量是在堆中，棧的操作速度比堆快很多。

8、盡早的將不再使用的變量引用賦給null 這樣做可以幫助jvm更快的進行內(nèi)存回收。當(dāng)然很多人其實對這種做法并不感冒。

java 文檔注釋是注釋什么的,不是有多行注釋了嗎?

1、【文檔注釋】是寫在類或者方法的上面的。

文檔注釋可以用eclipse導(dǎo)出chm格式的幫助文檔，拿給其他人用時，方便他人理解。文檔注釋被調(diào)用的方法，當(dāng)鼠標(biāo)移到上面時提醒注釋內(nèi)容。

使用文檔注釋時，需要在開始的?/**?之后，第一行或幾行是關(guān)于類、變量和方法的主要描述。

之后，可以包含一個或多個何種各樣的@?標(biāo)簽。每一個@標(biāo)簽必須在一個新行的開始或者在一行的開始緊跟星號(*)。多個相同類型的標(biāo)簽應(yīng)該放成一組。

2、【多行注釋】注釋的也是方法或類，言下之意就是一次性的將程序中的多行代碼注釋掉，但多行注釋的內(nèi)容不能用于生成一個開發(fā)者文檔。

3、【多行注釋與文檔注釋的區(qū)別】多行注釋的內(nèi)容不能用于生成一個開發(fā)者文檔，而文檔注釋的內(nèi)容可以生產(chǎn)一個開發(fā)者文檔。

擴展資料

java常用的文檔注釋標(biāo)簽

1、@author：標(biāo)識一個類的作者

實例：?@authordescription

2、@deprecated：指名一個過期的類或成員

實例：?@deprecateddescription

3、@exception：標(biāo)志一個類拋出的異常

實例：@exceptionexception-nameexplanation

4、{@inheritDoc}：從直接父類繼承的注釋

實例：Inheritsacommentfromtheimmediatesurperclass.

5、{@link}：插入一個到另一個主題的鏈接

實例：{@linknametext}

6、{@linkplain}：插入一個到另一個主題的鏈接，但是該鏈接顯示純文本字體

實例：Insertsanin-linelinktoanothertopic.

7、@param：說明一個方法的參數(shù)

實例：@paramparameter-nameexplanation

8、@return：說明返回值類型

實例：@returnexplanation

9、@see：指定一個到另一個主題的鏈接

實例：@seeanchor

10、@serial：說明一個序列化屬性

實例：@serialdescription

參考資料：百度百科-java注釋

java 中的幾種注釋方式

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

1、單行注釋?? //注釋的內(nèi)容

2、多行注釋??/*......*/

3、/**......*/，這種方式和第二種方式相似。這種格式是為了便于javadoc程序自動生成文檔。

下面介紹一下Javadoc的標(biāo)記：

特別聲明：

（1）javadoc針對public類生成注釋文檔

（2）javadoc只能在public、protected修飾的方法或者屬性之上

（3）javadoc注釋的格式化：前導(dǎo)*號和HTML標(biāo)簽

（4）javadoc注釋要僅靠在類、屬性、方法之前

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

（1）首先編寫.java文件

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

javadoc *.java //根據(jù)相應(yīng)的Java源代碼及其說明語句生成HTML文檔

//javadoc標(biāo)記：是@開頭的，對javadoc而言，特殊的標(biāo)記。

（3）在當(dāng)前目錄下就會產(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個方法,其作用是...*/

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鏈接到另一個文檔{@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);

}

/**這是第一個方法，其作用是....

*@deprecated?從版本1.2開始，不再建議使用此方法

*/

public?static?void?f1(){

System.out.println("fl()!");

}

/**這是第二個方法，其作用是....

*@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命令時，要加-version?-author

javadoc?-version?-author?-d?doc?*.java

（其中用-version用于提取源文件中的版本信息?-author用于提取源文件中的作者信息）

請列出java中的注釋

在Java里面主要有三種注釋：行注釋、段落注釋、文檔注釋

1)行注釋：行注釋也成為單行注釋，行注釋使用 “//注釋文字”的格式來對某一行的代碼進行注釋或者加以說明

2)段注釋：段注釋也成為多行注釋，通常是當(dāng)說明文字比較長的時候的注釋方法

3)文檔注釋：文檔注釋是Java里面的一個比較厲害的功能，它可以用于注釋類、屬性、方法等說明，而且通過JDK工具javadoc直接生成相關(guān)文檔，文檔注釋的基本格式為“/**...*/”，不僅僅如此，文檔注釋本身還存在語法

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

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

Java中代碼的注釋有三種：

// 注釋一行?

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

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

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

擴展資料

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

分享名稱：java代碼注釋一般格式 java中代碼注釋有哪些
URL標(biāo)題：http://m.kartarina.com/article14/hjocde.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供網(wǎng)頁設(shè)計公司、品牌網(wǎng)站制作、定制網(wǎng)站、搜索引擎優(yōu)化、網(wǎng)站制作、軟件開發(fā)

廣告

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