devttl/show-comment
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README.md and input

Browse Source
This commit is contained in:
林万程
2022-10-30 21:00:10 +08:00
parent 33a2f127c1
commit 3e0bb8e533
9 changed files with 25 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -1,8 +1,8 @@
# Show Comment Plugin
IDEA 智能注释插件
[![Version](https://img.shields.io/jetbrains/plugin/v/io.github.linwancen.show-comment.svg)](https://plugins.jetbrains.com/plugin/io.github.linwancen.show-comment)
[![Downloads](https://img.shields.io/jetbrains/plugin/d/io.github.linwancen.show-comment.svg)](https://plugins.jetbrains.com/plugin/io.github.linwancen.show-comment)
[![Version](https://img.shields.io/jetbrains/plugin/v/io.github.linwancen.show-comment.svg)](https://plugins.jetbrains.com/plugin/18553-show-comment/versions)
[![Downloads](https://img.shields.io/jetbrains/plugin/d/io.github.linwancen.show-comment.svg)](https://plugins.jetbrains.com/plugin/18553-show-comment)
Thanks JetBrains Licenses for Open Source.
@@ -11,6 +11,9 @@ Thanks JetBrains Licenses for Open Source.
Show doc comment at the Project view Tree, line End, json etc.
<ul>
<li>"xx-ClassNameOrSimpleName.json" and jump to field
<li>input `doc` `docc` -> /** */
<li>json doc from xxx.json.tsv
<li>json dict doc from (key).tsv
<li>from External Conf for folder, resources, COBOL etc.
<li>Config: settings -> Tools -> // Show Comment Global/Project
</ul>
@@ -33,6 +36,9 @@ Show doc comment at the Project view Tree, line End, json etc.
<ul>
<li>在结构树显示 文档注释
<li>在行末尾显示 文档注释
<li>输入 doc / docc 等生成 /** */
<li>json 字段注释从 xxx.json.tsv 读取
<li>json 字典注释从 键名.tsv 读取
<li>支持 "xx-类全名或简名.json" 文档注释与跳转到字段
<li>支持 从配置文件获取外部注释用于文件夹、资源、COBOL 等
<li>修改配置：设置 -> 工具 -> // Show Comment Global/Project
@@ -96,8 +102,8 @@ Show doc comment at the Project view Tree, line End, json etc.
<h2>中文更新说明:</h2>
<ul>
<li>2.05 增加 行末注释 从 xxx.json.tsv 中读取注释
<li>2.04 增加 行末注释 从 键名.tsv 中读取 json 的字典注释
<li>2.05 增加 行末注释 json 字段注释从 xxx.json.tsv 读取
<li>2.04 增加 行末注释 json 字典注释从 键名.tsv 读取
<li>2.03 增加 活动模板 输入 doc / docc 等生成 /** */
<li>2.02 增加 行末注释 `isA(xxx)` 和 `a.set(b.get)` 显示前一个注释
<li>2.01 增加 行末注释 支持 SQL, JavaScript, Python, Golang, Kotlin

4
build.gradle
View File

@@ -121,8 +121,8 @@ patchPluginXml {
<h2>中文更新说明:</h2>
<ul>
<li>2.05 增加 行末注释 从 xxx.json.tsv 中读取注释
<li>2.04 增加 行末注释 从 键名.tsv 中读取 json 的字典注释
<li>2.05 增加 行末注释 json 字段注释从 xxx.json.tsv 读取
<li>2.04 增加 行末注释 json 字典注释从 键名.tsv 读取
<li>2.03 增加 活动模板 输入 doc / docc 等生成 /** */
<li>2.02 增加 行末注释 `isA(xxx)` 和 `a.set(b.get)` 显示前一个注释
<li>2.01 增加 行末注释 支持 SQL, JavaScript, Python, Golang, Kotlin

4
src/main/idea/io/github/linwancen/plugin/show/java/JavaLangDoc.java
View File

@@ -6,10 +6,10 @@ import com.intellij.openapi.project.Project;
import com.intellij.psi.*;
import com.intellij.psi.javadoc.*;
import com.intellij.psi.util.PsiTreeUtil;
import io.github.linwancen.plugin.show.java.doc.OwnerToPsiDocUtils;
import io.github.linwancen.plugin.show.java.line.OwnerToPsiDocSkip;
import io.github.linwancen.plugin.show.bean.LineInfo;
import io.github.linwancen.plugin.show.bean.SettingsInfo;
import io.github.linwancen.plugin.show.java.doc.OwnerToPsiDocUtils;
import io.github.linwancen.plugin.show.java.line.OwnerToPsiDocSkip;
import io.github.linwancen.plugin.show.lang.base.BaseTagLangDoc;
import io.github.linwancen.plugin.show.lang.base.DocFilter;
import org.jetbrains.annotations.NotNull;

2
src/main/java/io/github/linwancen/plugin/show/ext/LineExt.java
View File

@@ -1,7 +1,7 @@
package io.github.linwancen.plugin.show.ext;
import io.github.linwancen.plugin.show.ext.conf.ConfCache;
import io.github.linwancen.plugin.show.bean.LineInfo;
import io.github.linwancen.plugin.show.ext.conf.ConfCache;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

2
src/main/java/io/github/linwancen/plugin/show/lang/GoLangDoc.java
View File

@@ -5,9 +5,9 @@ import com.goide.documentation.GoDocumentationProvider;
import com.goide.psi.GoReferenceExpressionBase;
import com.intellij.psi.PsiComment;
import com.intellij.psi.PsiElement;
import io.github.linwancen.plugin.show.lang.base.BaseLangDoc;
import io.github.linwancen.plugin.show.bean.LineInfo;
import io.github.linwancen.plugin.show.bean.SettingsInfo;
import io.github.linwancen.plugin.show.lang.base.BaseLangDoc;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

2
src/main/java/io/github/linwancen/plugin/show/lang/JsLangDoc.java
View File

@@ -5,9 +5,9 @@ import com.intellij.lang.javascript.documentation.JSDocumentationUtils;
import com.intellij.lang.javascript.psi.JSPsiReferenceElement;
import com.intellij.psi.PsiComment;
import com.intellij.psi.PsiElement;
import io.github.linwancen.plugin.show.lang.base.BaseLangDoc;
import io.github.linwancen.plugin.show.bean.LineInfo;
import io.github.linwancen.plugin.show.bean.SettingsInfo;
import io.github.linwancen.plugin.show.lang.base.BaseLangDoc;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

2
src/main/java/io/github/linwancen/plugin/show/lang/PythonLangDoc.java
View File

@@ -3,8 +3,8 @@ package io.github.linwancen.plugin.show.lang;
import com.intellij.psi.PsiElement;
import com.jetbrains.python.PythonLanguage;
import com.jetbrains.python.psi.PyReferenceExpression;
import io.github.linwancen.plugin.show.lang.base.BaseLangDoc;
import io.github.linwancen.plugin.show.bean.LineInfo;
import io.github.linwancen.plugin.show.lang.base.BaseLangDoc;
import org.jetbrains.annotations.NotNull;
public class PythonLangDoc extends BaseLangDoc {

2
src/main/java/io/github/linwancen/plugin/show/lang/base/BaseLangDoc.java
View File

@@ -10,9 +10,9 @@ import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.FileViewProvider;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiReference;
import io.github.linwancen.plugin.show.lang.JsonLangDoc;
import io.github.linwancen.plugin.show.bean.LineInfo;
import io.github.linwancen.plugin.show.bean.SettingsInfo;
import io.github.linwancen.plugin.show.lang.JsonLangDoc;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

6
src/main/resources/META-INF/plugin.xml
View File

@@ -7,6 +7,9 @@
Show doc comment at the Project view Tree, line End, json etc.
<ul>
<li>"xx-ClassNameOrSimpleName.json" and jump to field
<li>input `doc` `docc` -> /** */
<li>json doc from xxx.json.tsv
<li>json dict doc from (key).tsv
<li>from External Conf for folder, resources, COBOL etc.
<li>Config: settings -> Tools -> // Show Comment Global/Project
</ul>
@@ -29,6 +32,9 @@ Show doc comment at the Project view Tree, line End, json etc.
<ul>
<li>在结构树显示 文档注释
<li>在行末尾显示 文档注释
<li>输入 doc / docc 等生成 /** */
<li>json 字段注释从 xxx.json.tsv 读取
<li>json 字典注释从 键名.tsv 读取
<li>支持 "xx-类全名或简名.json" 文档注释与跳转到字段
<li>支持 从配置文件获取外部注释用于文件夹、资源、COBOL 等
<li>修改配置：设置 -> 工具 -> // Show Comment Global/Project