(1)單行注釋:以“ // ”開頭后面接所要加的說明的內容。如下面所示: //定義變量a int a = 10; //定義變量b int b = 20;上面的語句中,在編譯的過程就會直接略過注釋,只會編譯 int a = 10 和 int b = 20這兩句。由此可見注釋只是起著說明的作用。
創新互聯建站堅持“要么做到,要么別承諾”的工作理念,服務領域包括:成都做網站、網站建設、企業官網、英文網站、手機端網站、網站推廣等服務,滿足客戶于互聯網時代的個舊網站設計、移動媒體設計的需求,幫助企業找到有效的互聯網解決方案。努力成為您成熟可靠的網絡建設合作伙伴!
(2)多行注釋:以“/*”開頭,以“*/”結尾。 假設當你要說明你所寫的代碼的功能時。要說明的內容有很多。如果全部放在同一行會顯得很難看。所以一般會用多行來寫,如下所示// 說明//說明//說明//說明以上是用四個單行注釋來注釋四行說明。但如果有10行說明就要按十個“//”這顯示很麻煩,所以這時就可采用多行注釋。上面的可改成:/*說明說明說明說明*/也可以這樣/* 說明 說明 說明 說明 */
(3)文檔注釋:以“/**”開頭,以“*/”結尾。文檔注釋主要是生成文檔的。
1、【文檔注釋】是寫在類或者方法的上面的。
文檔注釋可以用eclipse導出chm格式的幫助文檔,拿給其他人用時,方便他人理解。文檔注釋被調用的方法,當鼠標移到上面時提醒注釋內容。
使用文檔注釋時,需要在開始的?/**?之后,第一行或幾行是關于類、變量和方法的主要描述。
之后,可以包含一個或多個何種各樣的@?標簽。每一個@標簽必須在一個新行的開始或者在一行的開始緊跟星號(*)。多個相同類型的標簽應該放成一組。
2、【多行注釋】注釋的也是方法或類,言下之意就是一次性的將程序中的多行代碼注釋掉,但多行注釋的內容不能用于生成一個開發者文檔。
3、【多行注釋與文檔注釋的區別】多行注釋的內容不能用于生成一個開發者文檔,而文檔注釋的內容可以生產一個開發者文檔。
擴展資料
java常用的文檔注釋標簽
1、@author:標識一個類的作者
實例:?@authordescription
2、@deprecated:指名一個過期的類或成員
實例:?@deprecateddescription
3、@exception:標志一個類拋出的異常
實例:@exceptionexception-nameexplanation
4、{@inheritDoc}:從直接父類繼承的注釋
實例:Inheritsacommentfromtheimmediatesurperclass.
5、{@link}:插入一個到另一個主題的鏈接
實例:{@linknametext}
6、{@linkplain}:插入一個到另一個主題的鏈接,但是該鏈接顯示純文本字體
實例:Insertsanin-linelinktoanothertopic.
7、@param:說明一個方法的參數
實例:@paramparameter-nameexplanation
8、@return:說明返回值類型
實例:@returnexplanation
9、@see:指定一個到另一個主題的鏈接
實例:@seeanchor
10、@serial:說明一個序列化屬性
實例:@serialdescription
參考資料:百度百科-java注釋
我看動力節點的java基礎大全301集教中的三種注釋方法:
1、單行注釋?? //注釋的內容
2、多行注釋??/*......*/
3、/**......*/,這種方式和第二種方式相似。這種格式是為了便于javadoc程序自動生成文檔。
下面介紹一下Javadoc的標記:
特別聲明:
(1)javadoc針對public類生成注釋文檔
(2)javadoc只能在public、protected修飾的方法或者屬性之上
(3)javadoc注釋的格式化:前導*號和HTML標簽
(4)javadoc注釋要僅靠在類、屬性、方法之前
下面主要舉例說明第三種注釋的應用:
(1)首先編寫.java文件
(2)在命令行中執行以下dos命令:
javadoc *.java //根據相應的Java源代碼及其說明語句生成HTML文檔
//javadoc標記:是@開頭的,對javadoc而言,特殊的標記。
(3)在當前目錄下就會產生doc文件夾,里面有一系列的.html文件
附上代碼:
[java]?view plain?copy
span?style="font-size:18px;"*/
/**javadoc注釋的內容
*/
public?class?Hello{
/**屬性上的注釋*/
public?String?name;
/**這是main方法,是程序的入口
*@param?args?用戶輸入參數
*/
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注釋內容
*@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?用戶輸入的參數,是數組
*@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?輸入參數i
*@see?Hello
*@throws?IOException?io異常
*/
public?static?String?f2(int?i)throws?IOException{
System.out.println("f1()!");
return?"OK";
}
}?/span
注意:
如果源文件中有用到@version,@author標記,則在執行javadoc命令時,要加-version?-author
javadoc?-version?-author?-d?doc?*.java
(其中用-version用于提取源文件中的版本信息?-author用于提取源文件中的作者信息)
1、單行(single-line)--短注釋://…… 單獨行注釋:在代碼中單起一行注釋, 注釋前最好有一行空行,并與其后的代碼具有一樣的縮進層級。如果單行無法完成,則應采用塊注釋。 注釋格式:/* 注釋內容 */ 行頭注釋:在代碼行的開頭進行注釋。主要為了使該行代碼失去意義。 注釋格式:// 注釋內容 行尾注釋:尾端(trailing)--極短的注釋,在代碼行的行尾進行注釋。一般與代碼行后空8(至少4)個格,所有注釋必須對齊。 注釋格式:代碼 + 8(至少4)個空格 + // 注釋內容 2、塊(block)--塊注釋:/*……*/ 注釋若干行,通常用于提供文件、方法、數據結構等的意義與用途的說明,或者算法的描述。一般位于一個文件或者一個方法的前面,起到引導的作用,也可以根據需要放在合適的位置。這種域注釋不會出現在HTML報告中。注釋格式通常寫成: /* * 注釋內容 */ 3、文檔注釋:/**……*/ 注釋若干行,并寫入javadoc文檔。每個文檔注釋都會被置于注釋定界符 /**......*/ ...
本文標題:java代碼文檔注釋 java文檔注釋的符號怎么打
URL分享:http://vcdvsql.cn/article40/ddsipeo.html
成都網站建設公司_創新互聯,為您提供動態網站、App設計、企業網站制作、網站建設、關鍵詞優化、企業建站
聲明:本網站發布的內容(圖片、視頻和文字)以用戶投稿、用戶轉載內容為主,如果涉及侵權請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網站立場,如需處理請聯系客服。電話:028-86922220;郵箱:631063699@qq.com。內容未經允許不得轉載,或轉載時需注明來源: 創新互聯