IDEA插件之注释快捷展示【Show Comment】

image.png

介绍

  • 在结构树显示 文档注释;
  • 在行末尾显示 文档注释;
  • 输入 doc / docc 等生成 /** */;
  • json 字段注释从 xxx.json.tsv 读取;
  • json 字典注释从 键名.tsv 读取;
  • 支持 “xx-类全名或简名.json” 文档注释与跳转到字段;
  • 支持 从配置文件获取外部注释用于文件夹、资源、COBOL 等;
  • 修改配置:设置 -> 工具 -> // Show Comment Global/Project;

使用

自动显示注释,在阅读源码时比较实用,能迅速了解代码表达的意思,当然排除注释不真实的情况哈,这里列举几个实例。

结构树显示注释

image.png

行末尾显示注释

image.png

配置

Show Comment Global

image.png
可针对注释的展现形式进行全局配置,如文本颜色、显示行数、前缀等。

Show Comment Project

image.png
也可对项目注释是否展示进行配置,配置包含正则和排除正则表达式。

使用感想

在对项目不太熟悉的情况下,对于快速了解项目,梳理业务逻辑,此插件还是比较实用的,提升工程熟悉进度。

评论