Java 18 新增@snipppet标签,注释中写样例代码更舒适了!
2024-09-29 23:58:40
在这次的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。第一时间了解前沿行业消息、分享深度技术干货、获取优质学习资源
最新文章
- 9.4用WebApi去连接外部认证服务
- Sublime Text 配置
- iwpriv
- Linux 删除mysql数据库失败的解决方法
- curl模拟Http请求
- windows 8 解决端口(COM和LPT)问题:Prolific USB-to-Serial Comm Port(COM4)驱动异常的问题
- BZOJ 4009 接水果
- 南桥先生谈《OUTLIERS》
- JavaScript--时间显示小插件
- 怎么把QQ我的收藏表情图片转移到另一台电脑上
- Spring Boot 整合JDBCTemplate
- S2-052 RCE漏洞 初步分析
- LA 3263 (欧拉定理)
- java之Stack详细介绍
- 第三章&#160;列表(c)有序列表
- Eclipse重命名项目名后如何彻底修改工程名
- day 52 Django 的中间件加载顺序
- awk练习笔记
- vue 拦截器
- django “如何”系列1:如何使用REMOTE_USER(远程用户)进行认证