百木园-与人分享,
就是让自己快乐。

Java 18 新增@snipppet标签,注释中写样例代码更舒适了!

在这次的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。第一时间了解前沿行业消息、分享深度技术干货、获取优质学习资源


来源:https://www.cnblogs.com/didispace/p/16206527.html
本站部分图文来源于网络,如有侵权请联系删除。

未经允许不得转载:百木园 » Java 18 新增@snipppet标签,注释中写样例代码更舒适了!

相关推荐

  • 暂无文章