當前位置:首頁 » 編程語言 » java文件注釋

java文件注釋

發布時間: 2022-04-12 16:06:16

1. eclipse怎麼設置創建一個java文件後自動加入注釋

eclipse設置創建一個java文件後自動加入注釋的方法:

1、通過菜單 Window->Preference 打開參數設置面板,然後選擇:
Java -> Code Style -> Code Templates

2. 為什麼要為程序添加註釋,在java程序中如何為程序添加註釋

注釋是用來給開發者或者是軟體後續的維護者來看的。一般是用來描述這一段代碼或者是程序做了些什麼樣的事情。實現了哪些功能,java裡面注釋代碼,可以分為行注釋和塊注釋,方法注釋等。
行注釋就是在需要注釋的代碼前加 //
塊注釋則是用 /* 和 */ 把文本段落框起來即可

3. Java 語言有哪幾種注釋符

單行注釋:
從「//」開始到行末結束,均視為單行注釋。

多行注釋:
從「/*」開始到「*/」結束,均視為多行注釋。

文檔注釋:
從「/**」開始到「*/」結束,均視為文檔注釋。

文檔注釋與多行注釋的區別:
文檔注釋可以用javadoc命令提取出來,生成類似於jdk文檔的網頁文件,以便於他人了解一個類的功能。

4. java 文檔注釋是注釋什麼的,不是有多行注釋了嗎

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

文檔注釋可以用eclipse導出chm格式的幫助文檔,拿給其他人用時,方便他人理解。文檔注釋被調用的方法,當滑鼠移到上面時提醒注釋內容。

使用文檔注釋時,需要在開始的/**之後,第一行或幾行是關於類、變數和方法的主要描述。

之後,可以包含一個或多個何種各樣的@標簽。每一個@標簽必須在一個新行的開始或者在一行的開始緊跟星號(*)。多個相同類型的標簽應該放成一組。

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

3、【多行注釋與文檔注釋的區別】多行注釋的內容不能用於生成一個開發者文檔,而文檔注釋 的內容可以生產一個開發者文檔。

(4)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

5. 如何在java程序中添加註釋

1、單行(single-line)--短注釋://…… 單獨行注釋:在代碼中單起一行注釋, 注釋前最好有一行空行,並與其後的代碼具有一樣的縮進層級。如果單行無法完成,則應採用塊注釋。 注釋格式:/* 注釋內容 */ 行頭注釋:在代碼行的開頭進行注釋。主要為了使該行代碼失去意義。 注釋格式:// 注釋內容 行章節附註釋:尾端(trailing)--極短的注釋,在代碼行的行尾進行注釋。一般與代碼行後空8(至少4)個格,所有注釋必須對齊。 注釋格式:代碼 + 8(至少4)個空格 + // 注釋內容
2、塊(block)--塊注釋:/*……*/ 注釋若干行,通常用於提供文件、方法、數據結構等的意義與用途的說明,或者演算法的描述。一般位於一個文件或者一個方法的前面,起到引導的作用,也可以根據需要放在合適的位置。這種域注釋不會出現在HTML報告中。注釋格式通常寫成: /* * 注釋內容 */
3、文檔注釋:/**……*/ 注釋若干行,並寫入javadoc文檔。每個文檔注釋都會被置於注釋定界符 /**......*/ ...

6. 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用於提取源文件中的作者信息)

7. JAVA程序中注釋的作用及類型分別是什麼

對於Java注釋我們主要了解三種:

1,// 注釋一行

2,/* ...... */ 注釋若干行

3,/**……*/文檔注釋 /** ...... */ 注釋若干行,並寫入 javadoc文檔

java圖標通常這種注釋的多行寫法如下: /** * ......... * ......... */

8. 什麼是注釋如何在Java程序中加入注釋

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

Java中代碼的注釋有三種:

// 注釋一行
/* ...... */ 注釋若干行
/** ...... */ 注釋若干行,並寫入 javadoc 文檔

前兩種比較容易理解,至於第三種,你學習Java看的api文檔就是javadoc程序根據第三種的注釋生成的。

(8)java文件注釋擴展閱讀

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

熱點內容
演算法和人性 發布:2025-01-20 03:28:31 瀏覽:473
軟體編程1級 發布:2025-01-20 03:19:39 瀏覽:952
嫁個編程男 發布:2025-01-20 02:51:39 瀏覽:933
掛勞文件夾 發布:2025-01-20 02:44:22 瀏覽:521
寫編程英文 發布:2025-01-20 02:37:50 瀏覽:16
安卓怎麼修改飢荒 發布:2025-01-20 02:20:54 瀏覽:619
android64位開發環境 發布:2025-01-20 01:58:01 瀏覽:262
阿里雲伺服器能搭美國站點 發布:2025-01-20 01:49:34 瀏覽:278
安卓手機壁紙如何更換成動態壁紙 發布:2025-01-20 01:40:27 瀏覽:706
安卓微信簽名在哪裡修改 發布:2025-01-20 01:25:31 瀏覽:110