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