作者:程序猿DD
博客:https://blog.didispace.com/
在这次的Java 18中,新增了一个@snipppet标签,主要用于JavaDoc中需要放示例代码的场景。其实在Java 18之前,已经有一个@code标签,可以用于在JavaDoc中编写小段的代码内容,比如在之前介绍Simple Web Serveropen视频中
提到的这段样例代码,就是用@code标签来写的:
*Example of a simple file server: *
{@code * var addr = new InetSocketAddress(8080); * var server = SimpleFileServer.createFileServer(addr, Path.of("/some/path"), OutputLevel.INFO); * server.start(); * }
虽然以前版本已经有类似功能,但依然还有各种各样的缺点,所以这次的@snipppet标签就在这些方面做了增强:
-
有效性检查,比如:当我们的样例代码中包含部分语法错误的时候,将会出现错误提示
-
语法高亮,如下图所示,使用@snippet的时候,IDE已经可以支持高亮,更有利于编辑,对比下@code的 内容,编辑的时候就没那么舒服了
-
代码编辑时的IDE支持也有了很大的提升,以往使用@code来编辑代码的时候基本就是当纯文本来编辑的,而现在在使用@snippet的时候,IDE给出了更多更好的支持,比如大家最喜欢的代码提示:
所以,这个功能DD觉得还是非常有用的,尤其是对于一些写框架和SDK的小伙伴(毕竟对JavaDoc的要求高)。
本篇内容对应视频已完成录制,点击查看:
我们创建了一个高质量的技术交流群,与优秀的人在一起,自己也会优秀起来,赶紧点击加群,享受一起成长的快乐。另外,如果你最近想跳槽的话,年前我花了2周时间收集了一波大厂面经,节后准备跳槽的可以点击这里领取!
推荐阅读- IDEA新建项目时的默认配置与模版配置
- 2022 Java生态系统报告:Java 11超Java 8、Oracle在缩水、Amazon在崛起!
- Java 17 新特性:文本块