Java 18 新增@snipppet標籤，註釋中寫樣例程式碼更舒適了！

程式猿DD發表於2022-04-29
Java

在這次的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。第一時間瞭解前沿行業訊息、分享深度技術乾貨、獲取優質學習資源

相關文章