Skip to content

Commit 740d1e9

Browse files
committed
修改了readme
1 parent 8b20239 commit 740d1e9

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,29 @@
1-
# idea-code-plugin
1+
## 简介
2+
3+
本项目是一个Intelli IDEAJ插件
4+
最初是为公司统一编程规范创建的,主要提交一些ide未能提供的代码检查,以及一些方便开发的功能,同时包含对Java以及Kotlin的支持,以及前端框架VueJS的支持
5+
6+
项目包含的功能可能有些杂,并不能在项目名称中体现出来,所以随便起了一个名字
7+
8+
本项目原本用于公司内部使用,开源的主要目的是想让大家能够提供一些问题检查和建议
9+
10+
该项目中的文字提示信息均采用了中文
11+
12+
## 功能介绍
13+
14+
### Java&Kotlin相关
15+
- java文件或kt文件的长度不能超过 800 行,否则提示错误
16+
- 类方法不得超过 100 行,否则提示错误
17+
- 类必须添加注释,否则提示错误
18+
- 接口方法必须添加注释,否则提示错误
19+
- 直接使用数字作为参数提示错误,提供的代码修正功能可以将参数提取为变量
20+
21+
### Spring相关
22+
23+
- 在类中使用@Value注解引入spring的环境变量时,对spring boot默认配置文件application.yml(暂不支持properties文件)的内容作了代码提示
24+
- 在类中使用@Value注解引入spring的环境变量,可以使用查找声明的方式跳转到application.yml中对应的配置项
25+
26+
### 前端相关
27+
- .vue文件在格式化的时候,模板中的标签属性会重新进行排序,且每个属性占一行
28+
- .vue文件在格式化的时候,模板中的标签属性以v-或:开头,对属性值进行格式化
29+
- .vue文件中模板部分(template标签部分)的长度不得超过150行,超过时请进行组件拆分

0 commit comments

Comments
 (0)