注釋java
❶ java中的注釋可分為三種類型
Java中三種類型的注釋:
單行注釋:// 注釋內容
多行注釋:/*... 注釋內容....*/
文本注釋:/**.. 注釋內容....*/
代碼注釋是架起程序設計者與程序閱讀者之間的通信橋梁,最大限度的提高團隊開發合作效率。也是程序代碼可維護性的重要環節之一。所以不是為寫注釋而寫注釋。
備註:簡單的代碼做簡單注釋,注釋內容不大於10個字即可,另外,持久化對象或VO對象的getter、setter方法不需加註釋。
(1)注釋java擴展閱讀:
類(模塊)注釋採用 /** …… */,在每個類(模塊)的頭部要有必要的注釋信息,包括:工程名;類(模塊)編號;命名空間;類可以運行的JDK版本;版本號;作者;創建時間;類(模塊)功能描述(如功能、主要演算法、內部各部分之間的關系、該類與其類的關系等,必要時還要有一些如特別的軟硬體要求等說明);主要函數或過程清單及本類(模塊)歷史修改記錄等。
❷ JAVA程序中注釋的作用及類型分別是什麼
對於Java注釋我們主要了解三種:
1,// 注釋一行
2,/* ...... */ 注釋若干行
3,/**……*/文檔注釋 /** ...... */ 注釋若干行,並寫入 javadoc文檔
java圖標通常這種注釋的多行寫法如下: /** * ......... * ......... */
❸ java中什麼是注釋
注釋就是,相當於解釋說明。有些項目太大了,就算是自己寫的代碼,時間長了也不知道是什麼意思。此時就需要注釋,方便查找。單行注釋 // 。多行注釋用/* */
❹ 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
<spanstyle="font-size:18px;">*/
/**javadoc注釋的內容
*/
publicclassHello{
/**屬性上的注釋*/
publicStringname;
/**這是main方法,是程序的入口
*@paramargs用戶輸入參數
*/
publicstaticvoidmain(String[]args){
System.out.println("HelloWorld!");
f1();
}
/**這是第1個方法,其作用是...*/
publicstaticvoidf1(){
System.out.println("f1()!");
}
}</span>
<spanstyle="font-size:18px;">importjava.io.IOException;
/**javadoc注釋內容
*@since1.0
*@version1.1
*@authorBlueJey
*<br>鏈接到另一個文檔{@linkHello},就這些
*seeHello
*/
publicclassHelloWorld{
/**非public,protected屬性上的注釋不生成*/
publicStringname;
/**這是main方法,是程序的入口
*@paramargs用戶輸入的參數,是數組
*@throwsIOExceptionmain方法io異常
*/
publicstaticvoidmain(Stringargs[])throwsIOException{
System.out.println("helloWorld!");
f1();
f2(1);
}
/**這是第一個方法,其作用是....
*@deprecated從版本1.2開始,不再建議使用此方法
*/
publicstaticvoidf1(){
System.out.println("fl()!");
}
/**這是第二個方法,其作用是....
*@return返回是否OK
*@parami輸入參數i
*@seeHello
*@throwsIOExceptionio異常
*/
publicstaticStringf2(inti)throwsIOException{
System.out.println("f1()!");
return"OK";
}
}</span>
[java]view plain
注意:
如果源文件中有用到@version,@author標記,則在執行javadoc命令時,要加-version-author
javadoc-version-author-ddoc*.java
(其中用-version用於提取源文件中的版本信息-author用於提取源文件中的作者信息)
❺ Java注釋有幾種類型
三種類型:
1、單選注釋:符號是://
2、塊注釋: 符號是: /* */ 可以跨多行
3、javadoc注釋: 符號是: /** */ 可以跨多行, 生成javadoc時,這樣的注釋會被生成標準的javaapi注釋。
❻ java怎麼注釋
//單行注釋
/** */多行注釋
❼ java 文檔注釋是注釋什麼的,不是有多行注釋了嗎
1、【文檔注釋】是寫在類或者方法的上面的。
文檔注釋可以用eclipse導出chm格式的幫助文檔,拿給其他人用時,方便他人理解。文檔注釋被調用的方法,當滑鼠移到上面時提醒注釋內容。
使用文檔注釋時,需要在開始的/**之後,第一行或幾行是關於類、變數和方法的主要描述。
之後,可以包含一個或多個何種各樣的@標簽。每一個@標簽必須在一個新行的開始或者在一行的開始緊跟星號(*)。多個相同類型的標簽應該放成一組。
2、【多行注釋】注釋的也是方法或類,言下之意就是一次性的將程序中的多行代碼注釋掉,但多行注釋的內容不能用於生成一個開發者文檔。
3、【多行注釋與文檔注釋的區別】多行注釋的內容不能用於生成一個開發者文檔,而文檔注釋 的內容可以生產一個開發者文檔。
(7)注釋java擴展閱讀
java常用的文檔注釋標簽
1、@author:標識一個類的作者
實例:@author description
2、@deprecated:指名一個過期的類或成員
實例:@deprecated description
3、@exception:標志一個類拋出的異常
實例:@exception exception-name explanation
4、{@inheritDoc}:從直接父類繼承的注釋
實例:Inherits a comment from the immediate surperclass.
5、{@link}:插入一個到另一個主題的鏈接
實例:{@link name text}
6、{@linkplain}:插入一個到另一個主題的鏈接,但是該鏈接顯示純文本字體
實例:Inserts an in-line link to another topic.
7、@param:說明一個方法的參數
實例:@param parameter-name explanation
8、@return:說明返回值類型
實例:@return explanation
9、@see:指定一個到另一個主題的鏈接
實例:@see anchor
10、@serial:說明一個序列化屬性
實例:@serial description
❽ 什麼是注釋如何在Java程序中加入注釋
試想一下,一個沒有一句注釋的程序源碼,怎麼讀,一個程序要上萬條代碼不可能全部記得住哪一塊是什麼用,而且一個項目也不會是一個人獨自完成,那樣效率太低,多人合作就要給別人說明,每一塊是什麼用,方便他人使用,方便自己更正,而這些說明文字就是注釋,注釋不會被執行,不影響運行結果。
Java中代碼的注釋有三種:
// 注釋一行
/* ...... */ 注釋若干行
/** ...... */ 注釋若干行,並寫入 javadoc 文檔
前兩種比較容易理解,至於第三種,你學習Java看的api文檔就是javadoc程序根據第三種的注釋生成的。
(8)注釋java擴展閱讀
注釋就是對代碼的解釋和說明,其目的是讓人們能夠更加輕松地了解代碼。注釋是編寫程序時,寫程序的人給一個語句、程序段、函數等的解釋或提示,能提高程序代碼的可讀性。
❾ Java如何進行單行注釋和多行注釋
(1)單行注釋:以「 // 」開頭後面接所要加的說明的內容。如下面所示: //定義變數a int a = 10; //定義變數b int b = 20;上面的語句中,在編譯的過程就會直接略過注釋,只會編譯 int a = 10 和 int b = 20這兩句。由此可見注釋只是起著說明的作用。
(2)多行注釋:以「/*」開頭,以「*/」結尾。 假設當你要說明你所寫的代碼的功能時。要說明的內容有很多。如果全部放在同一行會顯得很難看。所以一般會用多行來寫,如下所示// 說明//說明//說明//說明以上是用四個單行注釋來注釋四行說明。但如果有10行說明就要按十個「//」這顯示很麻煩,所以這時就可採用多行注釋。上面的可改成:/*說明說明說明說明*/也可以這樣/* 說明 說明 說明 說明 */
(3)文檔注釋:以「/**」開頭,以「*/」結尾。文檔注釋主要是生成文檔的。