美文网首页
Java 18 新增@snipppet标签,注释中写样例代码更舒

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

作者: 程序猿DD | 来源:发表于2022-04-29 14:23 被阅读0次

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

相关文章

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

    在这次的Java 18中,新增了一个@snipppet标签,主要用于JavaDoc中需要放示例代码的场景。其实在J...

  • 常用注释标签

    前言 在工作中,团队开发,为了代码的维护性,常要求写注释,现分享一些常用注释标签 注释用法 以vscode为例: ...

  • java注释

    java中的注释是为了方便自己和后人阅读代码而写的。就算是自己写的,时间长了也会忘记,所以代码注释是很重要的,这样...

  • html5新增标签

    HTML5 标签comment 注释标签用于在源文档中插入注释。注释内容不会被浏览器显示。为代码编写注释的好处是...

  • 认识HTML标签

    1.注释标签用于在源代码中插入注释。注释不会显示在浏览器中。我们可以利用注释我们暂时不需要的代码,也可以利用注释对...

  • Java基础

    Java注释说明注释信息只保存在Java源代码文件中,不会存在于编译后的class文件中。点睛之笔//单行注释/*...

  • 不是吧,都2020年了,注释标签还要写吗

    HTML 注释 注释标签 用于在 HTML 插入注释。 HTML 注释标签 您能够通过如下语法向 HTML 源代码...

  • 29.JSTL

    为了完全在JSP中消除Java代码,学习JAVA的标签库: Java标签库: 1:自定义标签库. 2:标准标签库(...

  • Java01笔记 数据类型

    代码小谈 规范的编码风格 注释 写注释 一、标识符 二、常量1、什么叫常量。 三、变量 Java中基本数据类型 常...

  • 为我大广州点赞

    昨天。 广东新增本土确诊病例19例,广州占18例;新增本土无症状感染者18例,广州占9例。 广州是人口超过1800...

网友评论

      本文标题:Java 18 新增@snipppet标签,注释中写样例代码更舒

      本文链接:https://www.haomeiwen.com/subject/fissyrtx.html