乐趣区

关于java:Java-18-新增snipppet标签注释中写样例代码更舒适了

jiezi

在这次的 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。第一工夫理解前沿行业音讯、分享深度技术干货、获取优质学习资源

退出移动版