java注釋,java注釋的快捷鍵

本文目錄一覽:

Java 語言有哪幾種注釋符?

單行注釋:

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

多行注釋:

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

文檔注釋:

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

文檔注釋與多行注釋的區別:

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

如何在java程序中添加註釋

1、單行(single-line)–短注釋://…… 單獨行注釋:在代碼中單起一行注釋, 注釋前最好有一行空行,並與其後的代碼具有一樣的縮進層級。如果單行無法完成,則應採用塊注釋。 注釋格式:/* 注釋內容 */ 行頭注釋:在代碼行的開頭進行注釋。主要為了使該行代碼失去意義。 注釋格式:// 注釋內容 行章節附註釋:尾端(trailing)–極短的注釋,在代碼行的行尾進行注釋。一般與代碼行後空8(至少4)個格,所有注釋必須對齊。 注釋格式:代碼 + 8(至少4)個空格 + // 注釋內容

2、塊(block)–塊注釋:/*……*/ 注釋若干行,通常用於提供文件、方法、數據結構等的意義與用途的說明,或者演算法的描述。一般位於一個文件或者一個方法的前面,起到引導的作用,也可以根據需要放在合適的位置。這種域注釋不會出現在HTML報告中。注釋格式通常寫成: /* * 注釋內容 */

3、文檔注釋:/**……*/ 注釋若干行,並寫入javadoc文檔。每個文檔注釋都會被置於注釋定界符 /**……*/ …

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

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注釋有幾種類型

三種類型:

1、單選注釋:符號是://

2、塊注釋: 符號是: /* */ 可以跨多行

3、javadoc注釋: 符號是: /** */ 可以跨多行, 生成javadoc時,這樣的注釋會被生成標準的javaapi注釋。

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

簡述JAVA程序中注釋的作用及類型。

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

1, // 注釋一行  

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

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

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

Java:

Java是一門面向對象編程語言,不僅吸收了C++語言的各種優點,還摒棄了C++里難以理解的多繼承、指針等概念,因此Java語言具有功能強大和簡單易用兩個特徵。Java語言作為靜態面向對象編程語言的代表,極好地實現了面向對象理論,允許程序員以優雅的思維方式進行複雜的編程 。

Java具有簡單性、面向對象、分散式、健壯性、安全性、平台獨立與可移植性、多線程、動態性等特點 。Java可以編寫桌面應用程序、Web應用程序、分散式系統和嵌入式系統應用程序等。

原創文章,作者:小藍,如若轉載,請註明出處:https://www.506064.com/zh-tw/n/256583.html

(0)
打賞 微信掃一掃 微信掃一掃 支付寶掃一掃 支付寶掃一掃
小藍的頭像小藍
上一篇 2024-12-15 12:41
下一篇 2024-12-15 12:41

相關推薦

  • java client.getacsresponse 編譯報錯解決方法

    java client.getacsresponse 編譯報錯是Java編程過程中常見的錯誤,常見的原因是代碼的語法錯誤、類庫依賴問題和編譯環境的配置問題。下面將從多個方面進行分析…

    編程 2025-04-29
  • Java JsonPath 效率優化指南

    本篇文章將深入探討Java JsonPath的效率問題,並提供一些優化方案。 一、JsonPath 簡介 JsonPath是一個可用於從JSON數據中獲取信息的庫。它提供了一種DS…

    編程 2025-04-29
  • Java Bean載入過程

    Java Bean載入過程涉及到類載入器、反射機制和Java虛擬機的執行過程。在本文中,將從這三個方面詳細闡述Java Bean載入的過程。 一、類載入器 類載入器是Java虛擬機…

    編程 2025-04-29
  • Java騰訊雲音視頻對接

    本文旨在從多個方面詳細闡述Java騰訊雲音視頻對接,提供完整的代碼示例。 一、騰訊雲音視頻介紹 騰訊雲音視頻服務(Cloud Tencent Real-Time Communica…

    編程 2025-04-29
  • python強行終止程序快捷鍵

    本文將從多個方面對python強行終止程序快捷鍵進行詳細闡述,並提供相應代碼示例。 一、Ctrl+C快捷鍵 Ctrl+C快捷鍵是在終端中經常用來強行終止運行的程序。當你在終端中運行…

    編程 2025-04-29
  • Java Milvus SearchParam withoutFields用法介紹

    本文將詳細介紹Java Milvus SearchParam withoutFields的相關知識和用法。 一、什麼是Java Milvus SearchParam without…

    編程 2025-04-29
  • Java 8中某一周的周一

    Java 8是Java語言中的一個版本,於2014年3月18日發布。本文將從多個方面對Java 8中某一周的周一進行詳細的闡述。 一、數組處理 Java 8新特性之一是Stream…

    編程 2025-04-29
  • Java判斷字元串是否存在多個

    本文將從以下幾個方面詳細闡述如何使用Java判斷一個字元串中是否存在多個指定字元: 一、字元串遍歷 字元串是Java編程中非常重要的一種數據類型。要判斷字元串中是否存在多個指定字元…

    編程 2025-04-29
  • VSCode為什麼無法運行Java

    解答:VSCode無法運行Java是因為默認情況下,VSCode並沒有集成Java運行環境,需要手動添加Java運行環境或安裝相關插件才能實現Java代碼的編寫、調試和運行。 一、…

    編程 2025-04-29
  • Java任務下發回滾系統的設計與實現

    本文將介紹一個Java任務下發回滾系統的設計與實現。該系統可以用於執行複雜的任務,包括可回滾的任務,及時恢復任務失敗前的狀態。系統使用Java語言進行開發,可以支持多種類型的任務。…

    編程 2025-04-29

發表回復

登錄後才能評論