Skip to content

LinWanCen/show-comment

BranchesTags

Repository files navigation

智能注释插件 Show Comment Plugin IDEA

Version Downloads

Thanks to JetBrains Licenses for Open Source.

Notes 说明

Show doc comment in the Project view Tree, line End, json, other

在文件树、行末、JSON 等地方显示注释.

  • Java, Kotlin, Groovy, Scala
  • C/C++/OC, Python, Go, Rust, Ruby
  • JS/TS, PHP, SQL
  • YAML/yml

English Note

  • tree doc from lang or README.md pom .gradle etc. by settings
  • input `doc` `docc` -> /** */
  • json doc from xxx.json.tsv
  • json dict doc from (key).tsv
  • "xx-ClassNameOrSimpleName.json" and jump to field
  • from External Conf for folder, resources, COBOL etc.
  • Config: settings -> Tools -> // Show Comment App/Global/Project
External Comment
Demo(GitHub)
  • Reload: Tools -> 🔄 // Reload External Comment
  • path/[any][filename.]ext.tree.tsv // file and folder tree comment 📝 📁
  • path/[any][filename.]ext.key.tsv // line keywords to split and comment
  • path/[any][filename.]ext.doc.tsv // line words comment
  • In path, "doc" can replace any, and can use % like in SQL, effect at previous layer when folder named -1
  • The lines in key.tsv will be concatenated with `|` to regexp; longer str should in front; startWith `?` to exclude
  • Chang tsv file in find pop window would not reload!
  • The tsv conf file must could be search in "Go to File" (Ctrl + Shift + N)
My Project
  • Show doc comment at the Project view Tree, line End, json etc.: Show Comment
  • show line count for file / method, show children count for dir in project view (tree on left): Line Num
  • Method call usage graph and maven dependency graph: Draw Graph
  • Find author/comment of multiple files or lines and export Find: Find Author
  • Auto sync coverage and capture coverage during debug: Sync Coverage

中文说明

  • 在结构树显示 文件注释 或 项目说明 (README.md pom.xml 等，可设置)
  • 在行末尾显示 引用对象的文档注释，欢迎反馈您想要支持的语言，欢迎 C# 大神研究 CsLineEnd.java
  • 输入 doc / docc 等生成 /** */
  • json 字段注释从 xxx.json.tsv 读取
  • json 字典注释从 键名.tsv 读取
  • 支持 "xx-类全名或简名.json" 读取字段注释和跳转
  • 支持 从配置文件获取外部注释用于文件夹、资源、COBOL 等
  • 修改配置：设置 -> 工具 -> // Show Comment App/Global/Project
外部注释
示例(Gitee) ：比如你要给 .go 的文件配置文件注释可以放在相同目录或父目录的 xxx.go.tree.tsv 中
  • 重新加载：工具 -> "🔄 // Reload External Comment"
  • path/[any][filename.]ext.tree.tsv // 文件(夹)注释 📝 📁
  • path/[any][filename.]ext.key.tsv // 切割关键字与注释
  • path/[any][filename.]ext.doc.tsv // 词注释
  • key.tsv 的每一行将会用`|`连接起来形成正则表达式，较长的关键字应该放在前面，用 `?` 开头排除
  • doc 文件夹可以替换任何一层文件夹，可以像 SQL 那样用 % 模糊匹配，文件夹名为 -1 时在上一层文件夹生效
  • 在搜索弹出窗中修改 tsv 文件将不会被重加载
  • tsv 配置文件必须能被搜索(Ctrl + Shift + N)
我的项目
  • 在文件树、行末、JSON 显示注释: Show Comment
  • 在文件树显示行数、文件数: Line Num
  • 生成 方法调用图 和 Maven 依赖图: Draw Graph
  • 查找多个文件或行的作者 与 导出搜索： Find Author
  • 自动同步覆盖率 和 调试中抓取覆盖率： Sync Coverage

找个女朋友

  • 我的情况：1993-11-03，软件工程师，广发银行编制，宅，LOLm，NS，看书，写文章，KTV，爬山，逛街
  • 我的性格：ISFP(探险家 内向 实际 感性 随性)
  • 希望对方：广东省，与家人关系好，爱笑甜美大眼睛
  • 有兴趣请联系 1498425439@qq.com，也欢迎反馈问题和需求

支持

  • 如果对你有所帮助，可以通过群或文章等形式分享给大家，在插件市场好评，或者给本项目 GitHub 主页一个 Star，您的支持是项目前进的动力。

Change Notes 更新说明

English Change Notes:

  • 2.16 Add line-end-comment support Rust, Ruby, PHP, C/C++/Object C, Scala, Groovy
  • 2.15 Add line-end-comment java anno doc
  • 2.14 Add line-end-comment java enum doc for Yes(1, "Yes")
  • 2.13 ★ Cache for 2023.3
  • 2.12 Add project-view-tree support Markdown and Asciidoc
  • 2.11 Add project-view-tree description from pom.xml and build.gradle
  • 2.10 Add line-end-comment not doc comment
  • 2.09 Add line-end-comment support Python doc strings
  • 2.08 Add i18n and chinese
  • 2.07 Add global-setting reset default
  • 2.06 Add project-view-tree xx-abc.xxx from Abc.java doc
  • 2.05 Add line-end-comment json doc from xxx.json.tsv
  • 2.04 Add line-end-comment json dict doc from (key).tsv
  • 2.03 Add live-templates input `doc` `docc` -> /** */
  • 2.02 Add line-end-comment show before doc for `isA(xxx)` and `a.set(b.get)`
  • 2.01 Add line-end-comment support SQL, JavaScript, Python, Golang, Kotlin
  • 2.00 ★★ support all JetBrains IDE
  • 1.24 Add PopupMenu Copy FileName:LineNumber
  • 1.23 Add project-view-tree setting for show when compact middle packages
  • 1.22 Add PopupMenu Copy ClassName.MethodName
  • 1.21 Add line-end-comment default skip only English when system lang is not `en`
  • 1.20 Add line-end-comment get doc first sentence checkbox
  • 1.19 Add line-end-comment supper doc at @Override, support doc tag like @author
  • 1.18 Add External Comment effect at previous layer when folder named -1
  • 1.17 Add line-end-comment skip doc text or class/member name by regexp
  • 1.16 Add line-end-comment skip when comments have been added
  • 1.15 Add line-end-comment support COBOL ext '', 'cbl', 'cob', 'cobol'
  • 1.14 Add line-end-comment skip Annotation, skip only English (ASCII)
  • 1.13 Add line-end-comment Copy With Line Comment & Add Line Comment
  • 1.12 ★ External Comment for COBOL etc
  • 1.11 Add json key jump to field
  • 1.10 Add project-view-tree for package from parent or other project
  • 1.9 Add project-view-tree for "xx-ClassNameOrSimpleName.json" and SPI file
  • 1.8 ★ line-end-comment for "xx-ClassNameOrSimpleName.json"
  • 1.7 Add line-end-comment setting for prefix and count
  • 1.6 Add line-end-comment independent switch for call, new, ref
  • 1.5 Add line-end-comment find next loop when none
  • 1.4 Add line-end-comment find element right to left
  • 1.3 ★ project-view-tree file and member comment
  • 1.2 Add line-end-comment settings for class prefix filter
  • 1.1 Add line-end-comment settings for text color

中文更新说明:

  • 2.16 增加 行末注释 支持 Rust, Ruby, PHP, C/C++/Object C, Scala, Groovy
  • 2.15 增加 行末注释 java 注解注释
  • 2.14 增加 行末注释 java 枚举注释用于 Yes(1, "是")
  • 2.13 ★ 缓存用于支持 2023.3
  • 2.12 增加 文件树注释 支持 Markdown and Asciidoc
  • 2.11 增加 文件树注释 模块描述 来自 pom.xml 和 build.gradle
  • 2.10 增加 行末注释 非文档注释
  • 2.09 增加 行末注释 支持 Python 文档字符串
  • 2.08 增加 多语言与中文支持
  • 2.07 增加 全局设置 复位默认值
  • 2.06 增加 文件树注释 xx-abc.xxx 来自 Abc.java 的文档注释
  • 2.05 增加 行末注释 json 字段注释从 xxx.json.tsv 读取
  • 2.04 增加 行末注释 json 字典注释从 键名.tsv 读取
  • 2.03 增加 活动模板 输入 doc / docc 等生成 /** */
  • 2.02 增加 行末注释 `isA(xxx)` 和 `a.set(b.get)` 显示前一个注释
  • 2.01 增加 行末注释 支持 SQL, JavaScript, Python, Golang, Kotlin
  • 2.00 ★★ 支持所有 JetBrains 软件
  • 1.24 增加 右键菜单 复制 文件名:行号
  • 1.23 增加 文件树注释 折叠中间包时显示中间包注释设置
  • 1.22 增加 右键菜单 复制 类名.方法名
  • 1.21 增加 行末注释 系统语言非英文时 默认 忽略纯英文
  • 1.20 增加 行末注释 获取第一句注释选项
  • 1.19 增加 行末注释 @Override 显示父方法注释，支持 @author 等注释标签
  • 1.18 增加 tsv 注释 文件夹名为 -1 时配置在上一层文件夹生效
  • 1.17 增加 行末注释 根据正则表达式跳过指定注释文本或类成员名字的注释
  • 1.16 增加 行末注释 已经添加行末注释时跳过
  • 1.15 增加 行末注释 COBOL 拓展名支持 无拓展名、cbl、cob、cobol
  • 1.14 增加 行末注释 忽略注解 与 忽略纯英文
  • 1.13 增加 行末注释 带注释复制 和 添加注释
  • 1.12 ★ tsv 注释 用于 COBOL 等
  • 1.11 增加 json 跳转到字段
  • 1.10 增加 文件树注释 在父包和其他项目的包中获取
  • 1.9 增加 文件树注释 "xx-类全名或简名.json" 和 SPI
  • 1.8 ★ 行末注释 "xx-类全名或简名.json"
  • 1.7 增加 行末注释 前缀和对象数设置
  • 1.6 增加 行末调用 new，引用注释独立开关
  • 1.5 增加 行末注释 没有注释时循环查找下一个对象
  • 1.4 增加 行末注释 从右往左查找行末注释对象
  • 1.3 ★ 文件树注释 (左侧项目导航文件树)
  • 1.2 增加 行末注释 类前缀配置
  • 1.1 增加 行末注释 颜色配置

Demo 示例

See in IDEA with this plugin | 安装插件后用 IDEA 查看

Maven down source jar 自动下载带注释的源码

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-dependency-plugin</artifactId>
        <version>3.1.2</version>
        <executions>
          <execution>
            <id>down_source_jar</id>
            <phase>validate</phase>
            <goals>
              <goal>sources</goal>
            </goals>
            <configuration>
              <includeArtifactIds>
                <!-- 公司统一出入参基类 -->
                com.company.common.base,
                <!-- 公司统一错误码 -->
                com.company.common.errcode
              </includeArtifactIds>
            </configuration>
          </execution>
        </executions>
      </plugin>

About

IDEA插件：在文件树、行末、JSON、COBOL 显示注释

plugins.jetbrains.com/plugin/18553-show-comment

Topics

comment javadoc cobol idea-plugin

Resources

Readme

License

MPL-2.0 license
Activity

Stars

88 stars

Watchers

1 watching

Forks

12 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages