java_3種註釋語句

来源:https://www.cnblogs.com/liudelantu/archive/2023/08/10/17621575.html
-Advertisement-
Play Games

**** # 1.內容 | | 解釋 | | | | | // 內容 | 單行註釋 | | /* 內容 */ | 多行註釋 | | /*** 內容 */ | 文檔註釋 | # 2.多行註釋 與 文檔註釋的區別 多行註釋: ![img](https://img2023.cnblogs.com/blog ...



1.內容

解釋
// 內容 單行註釋
/* 內容 */ 多行註釋
/*** 內容 */ 文檔註釋

2.多行註釋 與 文檔註釋的區別

多行註釋:

img
img


文檔註釋:JDK提供工具javadoc解析 註釋的內容,為生成API文檔做準備

img
img


3.生成步驟

img

img

img

img


4.javadoc標簽

標簽 描述 示例
@author 作者 @author liudelantu
@deprecated 指名一個過期的類或成員 @deprecated description
{@docRoot} 指明當前文檔根目錄的路徑 Directory Path
@exception 標誌一個類拋出的異常 @exception exception-name explanation
{@inheritDoc} 從直接父類繼承的註釋 Inherits a comment from the immediate surperclass.
{@link} 插入一個到另一個主題的鏈接 {@link name text}
{@linkplain} 插入一個到另一個主題的鏈接,但是該鏈接顯示純文本字體 Inserts an in-line link to another topic.
@param 說明一個方法的參數 @param parameter-name explanation
@return 說明返回值類型 @return explanation
@see 指定一個到另一個主題的鏈接 @see anchor
@serial 說明一個序列化屬性 @serial description
@serialData 說明通過writeObject( ) 和 writeExternal( )方法寫的數據 @serialData description
@serialField 說明一個ObjectStreamField組件 @serialField name type description
@since 標記當引入一個特定的變化時 @since release
@throws 和 @exception標簽一樣. The @throws tag has the same meaning as the @exception tag.
{@value} 顯示常量的值,該常量必須是static屬性。 Displays the value of a constant, which must be a static field.
@version 版本 @version 1.0

5.規範

類,方法的註釋,要用javadoc的方式寫,為了在生成的API文檔上 說明此類或方法的用途


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 7月27號下午2點 New 操作符做了什麼: 1. 創建一個新的空對象。 2. 將這個新對象的原型指向構造函數的原型。 3. 將構造函數的this指向這個新對象。 4. 根據構造函數返回類型作判斷,如果是值類型,返回newObj。如果是引用類型,就返回這個引用類型的對象 Vue2 數組push、sh ...
  • # CSS 選擇器權重 聲明:本文參考來源於[MDN CSS 優先順序](https://developer.mozilla.org/zh-CN/docs/Web/CSS/Specificity)(80%)和B站尚矽谷的[課程](https://m.bilibili.com/video/BV1p84y ...
  • 當我們疲於開發一個接一個的需求時,很容易忘記去關註網站的性能,到了某一個節點,猛地發現,隨著越來越多代碼的堆積,網站變得越來越慢。本文就是從這樣的一個背景出發,著手優化網站的前端性能,並總結出一套開發習慣,讓我們在日常開發時,也保持高性能,而不是又一次回過頭來優化性能。 ...
  • 隨著大屏幕技術的發展,大屏數字滾動效果在各種應用場景中越來越常見,例如數字展示、統計數據展示等。Vue3 作為一種流行的前端開發框架,提供了強大的工具和便捷的開發方式,非常適合實現大屏數字滾動效果。 本篇博文將介紹如何使用 Vue3 來實現大屏數字滾動效果。在實現過程中,我們可以使用調試工具進行測... ...
  • 通過編碼實戰瞭解quarkus攔截器的另一個高級特性:禁用類級別攔截器,這樣可以避免類級別和方法級別攔截器的疊加衝突 ...
  • # docker-compose ## compose安裝 ### Compose 簡介 Compose 是用於定義和運行多容器 Docker 應用程式的工具。通過 Compose,您可以使用 YML 文件來配置應用程式需要的所有服務。然後,使用一個命令,就可以從 YML 文件配置中創建並啟動所有服 ...
  • Spring可能成為您的所有企業應用程式的一站式商店。但是,Spring是模塊化的,允許您挑選適用於您的模塊,而無需引入其他模塊。下麵的部分提供了Spring Framework中所有可用模塊的詳細信息。 Spring Framework提供了大約20個模塊,可以根據應用程式要求使用。 ## 核心容 ...
  • 由於垃圾收集演算法的實現涉及大量的程式細節,而且各個平臺的虛擬機操作記憶體的方法又各不相同,因此本節不打算過多地討論演算法的實現,只是介紹幾種演算法的思想及其發展過程。 垃圾收集演算法概要 1、 標記-清除演算法 標記-清除演算法最基礎的收集演算法是“標記-清除”(Mark-Sweep)演算法,演算法分為“標記”和“清 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...