Java 18 新增@snipppet標簽,註釋中寫樣例代碼更舒適了!

来源:https://www.cnblogs.com/didispace/archive/2022/04/29/16206527.html
-Advertisement-
Play Games

在這次的Java 18中,新增了一個@snipppet標簽,主要用於JavaDoc中需要放示例代碼的場景。其實在Java 18之前,已經有一個@code標簽,可以用於在JavaDoc中編寫小段的代碼內容,比如在之前介紹Simple Web Server視頻中,提到的這段樣例代碼,就是用@code標簽 ...


在這次的Java 18中,新增了一個@snipppet標簽,主要用於JavaDoc中需要放示例代碼的場景。其實在Java 18之前,已經有一個@code標簽,可以用於在JavaDoc中編寫小段的代碼內容,比如在之前介紹Simple Web Server視頻中,提到的這段樣例代碼,就是用@code標簽來寫的:

 * <p> Example of a simple file server:
 * <pre>{@code
 *    var addr = new InetSocketAddress(8080);
 *    var server = SimpleFileServer.createFileServer(addr, Path.of("/some/path"), OutputLevel.INFO);
 *    server.start();
 * }</pre>

雖然以前版本已經有類似功能,但依然還有各種各樣的缺點,所以這次的@snipppet標簽就在這些方面做了增強:

  • 有效性檢查,比如:當我們的樣例代碼中包含部分語法錯誤的時候,將會出現錯誤提示

  • 語法高亮,如下圖所示,使用@snippet的時候,IDE已經可以支持高亮,更有利於編輯,對比下@code的 內容,編輯的時候就沒那麼舒服了

  • 代碼編輯時的IDE支持也有了很大的提升,以往使用@code來編輯代碼的時候基本就是當純文本來編輯的,而現在在使用@snippet的時候,IDE給出了更多更好的支持,比如大家最喜歡的代碼提示:

所以,這個功能DD覺得還是非常有用的,尤其是對於一些寫框架和SDK的小伙伴(畢竟對JavaDoc的要求高)。

本篇內容對應視頻已完成錄製,點擊查看:Java 18 新特性:@snipppet標簽

如果您學習過程中如遇困難?可以加入我們超高質量的技術交流群,參與交流與討論,更好的學習與進步!另外,不要走開,關註我!持續更新Java新特性教程!

歡迎關註我的公眾號:程式猿DD。第一時間瞭解前沿行業消息、分享深度技術乾貨、獲取優質學習資源


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

-Advertisement-
Play Games
更多相關文章
  • 字元集和字元編碼 字元集就是字元的集合,如常見的 ASCII字元集,GB2312字元集,Unicode字元集等。這些不同字元集之間最大的區別是所包含的字元數量的不同。 字元編碼則代表字元集的實際編碼規則,是用於電腦解析字元的,如 GB2312,GBK,UTF-8 等。字元編碼的本質就是如何使用二進 ...
  • 大家好,我是半夏👴,一個剛剛開始寫文的沙雕程式員.如果喜歡我的文章,可以關註➕ 點贊 👍 加我微信:frontendpicker,一起學習交流前端,成為更優秀的工程師~關註公眾號:搞前端的半夏,瞭解更多前端知識! 點我探索新世界! 原文鏈接 ==>http://sylblog.xin/archi ...
  • 微服務概覽 微服務是圍繞業務領域建模可獨立發佈的服務。服務封裝了對應功能並可以通過網路被其他服務訪問。 從外部來看,單個微服務被視為一個黑盒子。它使用最合適的協議在一個或多個網路端點(例如,隊列或REST API)上承載業務功能。消費者,無論他們是其他微服務還是其他類型的程式,都通過這些聯網的端點來 ...
  • 一個工作了6年的Java程式員,在阿裡二面,被問到“volatile”關鍵字。 然後,就沒有然後了… 同樣,另外一個去美團面試的工作4年的小伙伴,也被“volatile關鍵字“。 然後,也沒有然後了… 這個問題說實話,是有點偏底層,但也的確是併發編程裡面比較重要的一個關鍵字。 下麵,我們來看看普通人 ...
  • ( SpringCloud Gateway 整合Springfox/SwaggerUI3 之後調用某一個服務的介面時,請求路徑不會加上對應的服務名問題 ) 寫在前邊 當你看到這篇文章時,預設已經整合好了Springcloud/gateway/springfox(swaggerui3), 僅僅是在進行 ...
  • 作者 Atzuge 鏈接 https://www.cnblogs.com/zuge/p/7397255.html DataGrip是大名鼎鼎的JetBrains公司出品的,就是那個出品Intellij IDEA的公司。它是一款資料庫管理客戶端工具,方便連接到資料庫伺服器,執行sql、創建表、創建索引 ...
  • 前言 在使用Python的過程中,我最喜歡的就是Python的各種第三方庫,能夠完成很多操作。 下麵就給大家介紹5個通過Python構建的項目,以此來學習Python編程。 一、石頭剪刀布游戲 目標:創建一個命令行游戲,游戲者可以在石頭、剪刀和布之間進行選擇,與電腦PK。如果游戲者贏了,得分就會添 ...
  • 封裝:隱藏內部功能的具體實現,只保留和外部交流數據的介面。繼承:一個對象可以從它的父類繼承所有的通用的屬性和方法,併在無需重新編寫原來的類的情況下對這些功能進行擴展;最大的好處是實現代碼的高效重用。多態:同一個動作作用於不同的對象 所產生不同的行為。 ...
一周排行
    -Advertisement-
    Play Games
  • GoF之工廠模式 @目錄GoF之工廠模式每博一文案1. 簡單說明“23種設計模式”1.2 介紹工廠模式的三種形態1.3 簡單工廠模式(靜態工廠模式)1.3.1 簡單工廠模式的優缺點:1.4 工廠方法模式1.4.1 工廠方法模式的優缺點:1.5 抽象工廠模式1.6 抽象工廠模式的優缺點:2. 總結:3 ...
  • 新改進提供的Taurus Rpc 功能,可以簡化微服務間的調用,同時可以不用再手動輸出模塊名稱,或調用路徑,包括負載均衡,這一切,由框架實現並提供了。新的Taurus Rpc 功能,將使得服務間的調用,更加輕鬆、簡約、高效。 ...
  • 本章將和大家分享ES的數據同步方案和ES集群相關知識。廢話不多說,下麵我們直接進入主題。 一、ES數據同步 1、數據同步問題 Elasticsearch中的酒店數據來自於mysql資料庫,因此mysql數據發生改變時,Elasticsearch也必須跟著改變,這個就是Elasticsearch與my ...
  • 引言 在我們之前的文章中介紹過使用Bogus生成模擬測試數據,今天來講解一下功能更加強大自動生成測試數據的工具的庫"AutoFixture"。 什麼是AutoFixture? AutoFixture 是一個針對 .NET 的開源庫,旨在最大程度地減少單元測試中的“安排(Arrange)”階段,以提高 ...
  • 經過前面幾個部分學習,相信學過的同學已經能夠掌握 .NET Emit 這種中間語言,並能使得它來編寫一些應用,以提高程式的性能。隨著 IL 指令篇的結束,本系列也已經接近尾聲,在這接近結束的最後,會提供幾個可供直接使用的示例,以供大伙分析或使用在項目中。 ...
  • 當從不同來源導入Excel數據時,可能存在重覆的記錄。為了確保數據的準確性,通常需要刪除這些重覆的行。手動查找並刪除可能會非常耗費時間,而通過編程腳本則可以實現在短時間內處理大量數據。本文將提供一個使用C# 快速查找並刪除Excel重覆項的免費解決方案。 以下是實現步驟: 1. 首先安裝免費.NET ...
  • C++ 異常處理 C++ 異常處理機制允許程式在運行時處理錯誤或意外情況。它提供了捕獲和處理錯誤的一種結構化方式,使程式更加健壯和可靠。 異常處理的基本概念: 異常: 程式在運行時發生的錯誤或意外情況。 拋出異常: 使用 throw 關鍵字將異常傳遞給調用堆棧。 捕獲異常: 使用 try-catch ...
  • 優秀且經驗豐富的Java開發人員的特征之一是對API的廣泛瞭解,包括JDK和第三方庫。 我花了很多時間來學習API,尤其是在閱讀了Effective Java 3rd Edition之後 ,Joshua Bloch建議在Java 3rd Edition中使用現有的API進行開發,而不是為常見的東西編 ...
  • 框架 · 使用laravel框架,原因:tp的框架路由和orm沒有laravel好用 · 使用強制路由,方便介面多時,分多版本,分文件夾等操作 介面 · 介面開發註意欄位類型,欄位是int,查詢成功失敗都要返回int(對接java等強類型語言方便) · 查詢介面用GET、其他用POST 代碼 · 所 ...
  • 正文 下午找企業的人去鎮上做貸後。 車上聽同事跟那個司機對罵,火星子都快出來了。司機跟那同事更熟一些,連我在內一共就三個人,同事那一手指桑罵槐給我都聽愣了。司機也是老社會人了,馬上聽出來了,為那個無辜的企業經辦人辯護,實際上是為自己辯護。 “這個事情你不能怪企業。”“但他們總不能讓銀行的人全權負責, ...