『壹』 java中文檔注釋各欄位的含義是什麼例如author表示作者,para表示參數等
常用Java注釋標簽(Java comment
tags)
@author 作者
適用范圍:文件、類、方法
(*多個作者使用多個@author標簽標識,java
doc中顯示按輸入時間順序羅列。)
例:*
@author Leo. Yao
@param 輸入參數的名稱 說明
適用范圍:方法
例:* @param str
the String用來存放輸出信息。
@return 輸出參數說明
適用范圍:方法
例: *
@return <code>true</code>執行成功;
* <code>false</code>執行失敗.
@since
JDK版本
用於標識編譯該文件所需要的JDK環境。
適用范圍:文件、類
例: * @since
JDK1.6
@version 版本號
用於標識注釋對象的版本號
適用范圍:文件、類、方法
例: * @version 1.0
@see 鏈接目標
表示參考。會在java 文檔中生成一個超鏈接,鏈接到參考的類容。使用中的感覺是@see不需要包路徑,對我這種懶人比較喜歡,相對{@link
}這種既要加大括弧,有需要包路徑,我還是選擇偷懶,當然你要是不介意使用import導入要link的類,那就可以達到@see的效果,所以總體來說,還是選擇@see,當然兩個在特殊場合下還是用法不一樣的
用法:
@see
#field
@see #Constructor(Type,
Type...)
@see #Constructor(Type id, Type
id...)
@see #method(Type,
Type,...)
@see #method(Type id, Type,
id...)
@see
Class
@see
Class#field
@see Class#Constructor(Type,
Type...)
@see Class#Constructor(Type id,
Type id)
@see Class#method(Type,
Type,...)
@see Class#method(Type id, Type
id,...)
@see
package.Class
@see
package.Class#field
@see
package.Class#Constructor(Type, Type...)
@see
package.Class#Constructor(Type id, Type id)
@see package.Class#method(Type,
Type,...)
@see package.Class#method(Type
id, Type, id)
@see
package
@throws 異常
標識出方法可能拋出的異常
適用范圍:方法
例: * @throws IOException If an input or output
exception occurred
@deprecated 解釋
標識對象過期
適用范圍:文件、類、方法
@link 鏈接地址
鏈接到一個目標,用法類似@see。但常放在注釋的解釋中形如{@link …}
例:
/**
* @deprecated As of JDK 1.1,
replaced by
* {@link
#setBounds(int,int,int,int)}
*/
『貳』 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>
[java]view plain
<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>
注意:
如果源文件中有用到@version,@author標記,則在執行javadoc命令時,要加-version-author
javadoc-version-author-ddoc*.java
(其中用-version用於提取源文件中的版本信息-author用於提取源文件中的作者信息)
『叄』 java 文檔注釋是注釋什麼的,不是有多行注釋了嗎
1、【文檔注釋】是寫在類或者方法的上面的。
文檔注釋可以用eclipse導出chm格式的幫助文檔,拿給其他人用時,方便他人理解。文檔注釋被調用的方法,當滑鼠移到上面時提醒注釋內容。
使用文檔注釋時,需要在開始的/**之後,第一行或幾行是關於類、變數和方法的主要描述。
之後,可以包含一個或多個何種各樣的@標簽。每一個@標簽必須在一個新行的開始或者在一行的開始緊跟星號(*)。多個相同類型的標簽應該放成一組。
2、【多行注釋】注釋的也是方法或類,言下之意就是一次性的將程序中的多行代碼注釋掉,但多行注釋的內容不能用於生成一個開發者文檔。
3、【多行注釋與文檔注釋的區別】多行注釋的內容不能用於生成一個開發者文檔,而文檔注釋 的內容可以生產一個開發者文檔。
(3)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注釋中的<code></code>標記作用是什麼
java注釋中的<code></code>標記表示代碼的標記。
既然是出現在注釋中,那麼程序是不會執行和解析的。
而這種寫法通常是由程序開發人員沿用了html或者jsp裡面的標簽的格式,用來寫注釋內容,從而方便在以後能直觀看出當前程序的功能。
『伍』 java注釋里的這些標記分別是什麼意思詳細點
<code> 標簽用於表示計算機源代碼或者其他機器可以閱讀的文本內容。
<tt> 標簽呈現類似打字機或者等寬的文本效果。
<p> 標簽定義段落。
<i> 標簽顯示斜體文本效果。
<a> 標簽定義超鏈接,用於從一張頁面鏈接到另一張頁面。
詳細信息請參考http://www.w3school.com.cn/,網址裡面有各種表情詳解及使用教程。
『陸』 java里,jsp頁面怎麼注釋含標簽的語句
有兩種方式:一是html方式注釋,而是jsp方式注釋。
html方式注釋:在jsp標簽的左右尖括弧中添加註釋語句。(下面注釋了c:out標簽)
<!--c:out...-->
sp方式注釋:把要注釋的內容用jsp代碼標記包含並注釋:
<%/*
<c:out...>
*/%>
推薦第二種,因為第一種會將你的代碼暴露在最終的html中,而且也增加了頁面大小。
『柒』 Java 文檔注釋中的幾個Tag標記
<code></code> 標簽用於表示計算機源代碼或者其他機器可以閱讀的文本內容
<tt></tt> 標簽呈現類似打字機或者等寬的文本效果。
<p> 一個段落,每個段落之間一般會有一個空行。
<i></i> 標簽顯示斜體文本效果
<a></a> 增加鏈接
『捌』 Java如何進行單行注釋和多行注釋
(1)單行注釋:以「 // 」開頭後面接所要加的說明的內容。如下面所示: //定義變數a int a = 10; //定義變數b int b = 20;上面的語句中,在編譯的過程就會直接略過注釋,只會編譯 int a = 10 和 int b = 20這兩句。由此可見注釋只是起著說明的作用。
(2)多行注釋:以「/*」開頭,以「*/」結尾。 假設當你要說明你所寫的代碼的功能時。要說明的內容有很多。如果全部放在同一行會顯得很難看。所以一般會用多行來寫,如下所示// 說明//說明//說明//說明以上是用四個單行注釋來注釋四行說明。但如果有10行說明就要按十個「//」這顯示很麻煩,所以這時就可採用多行注釋。上面的可改成:/*說明說明說明說明*/也可以這樣/* 說明 說明 說明 說明 */
(3)文檔注釋:以「/**」開頭,以「*/」結尾。文檔注釋主要是生成文檔的。
『玖』 java 中/**是什麼
你的j2se只學了一點而已,不管怎樣,都要先把j2se學好,這是基礎。j2se的學習順序一般是這樣的:基礎語法 -> 面向對象入門 -> 異常處理 -> 數組 -> 常用類 -> 容器(相當重要) -> IO -> 線程 -> 網路 -> GUI。
既然你io,thread都學了,其餘那些還有沒學的,建議去看看馬士兵的j2se視頻,其實我覺得如果想打好基礎的話,這套視頻應該全部過過,特別是開始的內存分析和面向對象分析。學完j2se要做做幾個基礎的桌面項目,像什麼貪吃蛇啊、俄羅斯方塊、簡單的聊天器等等,這樣才能把知識整合起來,加深對j2se的理解。
如果想走j2ee路線的話,接下來應該學資料庫,再學html、css、JavaScript、jsp/servlet,也就是web的入門,之後做做web項目,比如小bbs、網上商城等等。學通了就學框架,這期間會穿插很多東西,例如xml、uml、log4j、jUnit等等,最後學設計模式和面向對象的分析。計算機的東西是很多的,不要學死,也不要想著學完,最重要的是學會解決問題的方法。開始肯定要模仿別人的代碼,不斷模仿,多看,看完一定要自己寫幾遍,只有能寫出來了的,才是自己的東西,建議開始時多背點東西,包括一些常用類啊、一些概念性的東西,因為背多了自己就熟悉了。
資料庫的要另找,網上能找到馬士兵的Oracle,講的很不錯的!!
shopping這個項目也有從頭帶到尾的,也是馬士兵的,要找找
做項目是很重要的,從簡單的做起,慢慢體會其中的分析與設計
學java還是從視頻入門的好,千萬不要一開始就去看《Thinking in java》,吃力不討好,學到web時可以看看張孝祥的《深入體驗JAVA Web開發內幕——核心基礎》,寫的很詳細,不過他的視頻一般,JavaScript就看《JavaScript高級程序設計》,html比較簡單,css也比較簡單,不過css布局因人而異,有人覺得很好理解,有人覺得很難,搞個Dreamweaver多練練也就熟悉了。設計模式可以看《大話設計模式》,入門很好!
你的j2se只學了一點而已,不管怎樣,都要先把j2se學好,這是基礎。j2se的學習順序一般是這樣的:基礎語法 -> 面向對象入門 -> 異常處理 -> 數組 -> 常用類 -> 容器(相當重要) -> IO -> 線程 -> 網路 -> GUI。
既然你io,thread都學了,其餘那些還有沒學的,建議去看看馬士兵的j2se視頻,其實我覺得如果想打好基礎的話,這套視頻應該全部過過,特別是開始的內存分析和面向對象分析。學完j2se要做做幾個基礎的桌面項目,像什麼貪吃蛇啊、俄羅斯方塊、簡單的聊天器等等,這樣才能把知識整合起來,加深對j2se的理解。
如果想走j2ee路線的話,接下來應該學資料庫,再學html、css、JavaScript、jsp/servlet,也就是web的入門,之後做做web項目,比如小bbs、網上商城等等。學通了就學框架,這期間會穿插很多東西,例如xml、uml、log4j、jUnit等等,最後學設計模式和面向對象的分析。計算機的東西是很多的,不要學死,也不要想著學完,最重要的是學會解決問題的方法。開始肯定要模仿別人的代碼,不斷模仿,多看,看完一定要自己寫幾遍,只有能寫出來了的,才是自己的東西,建議開始時多背點東西,包括一些常用類啊、一些概念性的東西,因為背多了自己就熟悉了。
資料庫的要另找,網上能找到馬士兵的Oracle,講的很不錯的!!
shopping這個項目也有從頭帶到尾的,也是馬士兵的,要找找
做項目是很重要的,從簡單的做起,慢慢體會其中的分析與設計
學java還是從視頻入門的好,千萬不要一開始就去看《Thinking in java》,吃力不討好,學到web時可以看看張孝祥的《深入體驗JAVA Web開發內幕——核心基礎》,寫的很詳細,不過他的視頻一般,JavaScript就看《JavaScript高級程序設計》,html比較簡單,css也比較簡單,不過css布局因人而異,有人覺得很好理解,有人覺得很難,搞個Dreamweaver多練練也就熟悉了。設計模式可以看《大話設計模式》,入門很好!
『拾』 java注釋里的這些標記分別是什麼意思
方法/步驟
java注釋,總共有3種注釋方法。
注意事項
注釋內容是不被編輯的內容,只是解釋說明
注釋,為了更方便的閱讀
每次單行注釋、多行注釋,要選中要注釋的內容