vlambda博客
学习文章列表

在这次的Java 18中，新增了一个@snipppet标签，主要用于JavaDoc中需要放示例代码的场景。其实在Java 18之前，已经有一个@code标签，可以用于在JavaDoc中编写小段的代码内容，比如在之前介绍Simple Web Serveropen视频中

提到的这段样例代码，就是用@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的要求高）。

本篇内容对应视频已完成录制，点击查看：

我们创建了一个高质量的技术交流群，与优秀的人在一起，自己也会优秀起来，赶紧，享受一起成长的快乐。另外，如果你最近想跳槽的话，年前我花了2周时间收集了一波大厂面经，节后准备跳槽的可以！

关注后端面试那些事，回复【2022面经】

获取最新大厂Java面经

后端面试那些事

专注分享后端干货！面向大厂，一起进步！

5篇原创内容

Official Account

最后重要提示： 高质量的技术交流群，限时免费开放，今年抱团最重要。想进群的，关注 SpringForAll社区 ，回复关键词： 加群 ，拉你进群。