Skip to content

Commit d619264

Browse files
committed
update man usage
1 parent cf3943c commit d619264

File tree

2 files changed

+30
-28
lines changed

2 files changed

+30
-28
lines changed

README.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<a href="https://github.com/caofanCPU/D8gerAutoCode/blob/master/LICENCE"><img src="https://badgen.net/github/license/caofanCPU/D8gerAutoCode?color=green" alt="license"></a>
44
<a href="https://github.com/caofanCPU/D8gerAutoCode/issues"><img src="https://badgen.net/github/open-issues/caofanCPU/D8gerAutoCode" alt="issues"></a>
55
<a href="https://github.com/caofanCPU/D8gerAutoCode/stargazers"><img src="https://badgen.net/github/stars/caofanCPU/D8gerAutoCode" alt="stars"></a>
6-
<a href="https://github.com/caofanCPU/D8gerAutoCode/pulls"><img src="https://badgen.net/badge/PRs/welcome/cyan" alt="PRs Welcome"></a>
6+
<a href="https://github.com/caofanCPU/D8gerAutoCode/pulls"><img src="https://badgen.net/badge/PRs/welcome/cyan" alt="PRs welcome"></a>
77
<a href="http://www.debuggerpowerzcy.top/"><img src="https://badgen.net/badge/organization/join%20us/cyan" alt="open-source-organization"></a>
88

99
## IDEA Code Automatically Generate Plugin • `For Java Version`
@@ -46,7 +46,7 @@ Well, that's a valid question for my drive to find the repeat parts at daily wor
4646
### Using manual(v3.0+)
4747
1.Open the configuration box to set the generation parameters, `Preference` --> `Other Settings` --> `D8gerAutoCode`
4848

49-
2.Check the file to be generated and choose the generation path, rewrite `author``author` and `locale`, and click the button to save your configuration.
49+
2.Check the file to be generated and choose the generation path, rewrite `author``apiUrlPrefix` and `locale`, and click the button to save your configuration.
5050

5151
<div align="center">
5252
<img src="http://file.debuggerpowerzcy.top/power/D8King.jpg" />
@@ -60,32 +60,32 @@ Well, that's a valid question for my drive to find the repeat parts at daily wor
6060
3. Under the default configuration, `D8gerAutoCode` directory and `data table SQL definitions` and **Web codes** will be generated
6161

6262
4. So, What you need to do:
63-
- Under a multi-module project, configure the generated file output directory, for example, **`Mo.java`** should be moved into the `model` directory
64-
- Add non-null constraints to **`xx.sql`** as required
65-
- If you generated the **Controller.java** file, please note the interface returns type of **`Object`**, it should be modified to the project's uniform return type
66-
- In the above steps the `xx.java` file will report some errors, ***don't worry***, these just require you to import packages
63+
- Under a multi-module project, configure the generated file output directory, for example, **`Mo.java`** should be moved into the `model` directory
64+
- Add non-null constraints to **`xx.sql`** as required
65+
- If you generated the **Controller.java** file, please note the interface returns type of **`Object`**, it should be modified to the project's uniform return type
66+
- In the above steps the `xx.java` file will report some errors, ***don't worry***, these just require you to import packages
6767

68-
5.1 Default configuration file template for easter egg:
69-
    - In the ***`resource`*** root directory of the module where the `Model class` is located, create `d8ger.properties` property configuration file
70-
    - Type `d8ger` and click on `Tools`-> `D8ger`-> `D8gerMore`, and you will find some surprise
68+
5. Default configuration file template for easter egg:
69+
- In the ***`resource`*** root directory of the module where the `Model class` is located, create `d8ger.properties` property configuration file
70+
- Type `d8ger` and click on `Tools`-> `D8ger`-> `D8gerMore`, and you will find some surprise
7171

72-
5.2 Regex template for easter egg:
72+
6. Regex template for easter egg:
7373
- Choose any blank file, Type `regex` and click on `Tools`-> `D8ger`-> `D8gerMore`, and you will find some surprise
7474

75-
5.2 NASA template for easter egg:
75+
7. NASA template for easter egg:
7676
- Choose any blank file, Type `nasa` and click on` Tools`-> `D8ger`-> `D8gerMore`, and you will get the NASA manual
7777
- Follow the manual, custom your config and write your own multi-lines need to be batch handled, then you will find some surprise
7878

79-
5.3 Camel-Underline-Uppercase-Uncapitalize-Lowercase circle convert by one-click
79+
8. Camel-Underline-Uppercase-Uncapitalize-Lowercase circle convert by one-click
8080
- Choose word text in any editing file, press `alt` + `shift` + `cmd` + `U`, you'll find the changed word
8181
- If not satisfied just press the shortcut again and again util you are.
8282

83-
6. You will get the following default configuration information
84-
    - It's recommended that you change the configuration items
85-
        - `author` (you can't sign my name for the pits you dug!)
86-
        - `apiUrlPrefix` (the interface url prefix should be configured as the project interface unified URL prefix)
87-
        - generate file output directory under a multi-module project
88-
    - As for `boolean` configuration items, let you choose which files need to be generated, and specify output directory is optional
83+
9. You will get the following default configuration information
84+
- It's recommended that you change the configuration items
85+
- `author` (you can't sign my name for the pits you dug!)
86+
- `apiUrlPrefix` (the interface url prefix should be configured as the project interface unified URL prefix)
87+
- generate file output directory under a multi-module project
88+
- As for `boolean` configuration items, let you choose which files need to be generated, and specify output directory is optional
8989

9090
> By the way, these default shortcuts used in Mac OS, if you use Windows just take `cmd` into `ctrl`.
9191
@@ -110,6 +110,7 @@ Well, that's a valid question for my drive to find the repeat parts at daily wor
110110
111111
```
112112
Solution
113+
0. If you upgrade version 3.0+, you won't see it again.
113114
1. Because the IDEA file uses the VFS mechanism, as a plug-in to use the monitoring file I think it is not cost-effective
114115
2. I also found a reason aboub editing .properties file, sometimes it will take one or two minutes to refresh after you finished
115116
3. So, press 'cmd' + 's' to force refreshing .properties file and you will solve it.

README_CN.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
##### 使用手册(v3.0+)
4747
1.打开配置框设置生成参数 `Preference` --> `Other Settings` --> `D8gerAutoCode`
4848

49-
2.勾选要生成的文件及生成路径, 指明 `author``author``locale`, 保存即可
49+
2.勾选要生成的文件及生成路径, 指明 `author``apiUrlPrefix``locale`, 保存即可
5050

5151
<div align="center">
5252
<img src="http://file.debuggerpowerzcy.top/power/D8King.jpg" />
@@ -60,27 +60,27 @@
6060
3. 默认配置下, 会生成`D8gerAutoCode`目录及数据表SQL定义和Web代码, 共9个
6161

6262
4. 你需要做的:
63-
- 多模块工程下, 配置生成文件输出目录, 例如**`Mo.java`**配置`model`目录
64-
- 根据需求对**`xx.sql`**增加非空约束
65-
- 如果你生成了**`Controller.java`**文件, ***请注意接口返回对象类型***, 应修改为项目统一的返回类型
66-
- 在上述步骤中, 代码文件会飘红报错, 别慌, 这需要你自行导包解决
63+
- 多模块工程下, 配置生成文件输出目录, 例如**`Mo.java`**配置`model`目录
64+
- 根据需求对**`xx.sql`**增加非空约束
65+
- 如果你生成了**`Controller.java`**文件, ***请注意接口返回对象类型***, 应修改为项目统一的返回类型
66+
- 在上述步骤中, 代码文件会飘红报错, 别慌, 这需要你自行导包解决
6767

68-
5.1 默认配置文件模板, 代码彩蛋:
68+
5. 默认配置文件模板, 代码彩蛋:
6969
-`Model类`所在模块的***`resource`***根目录下, 创建`d8ger.properties`属性配置文件
7070
- 输入`d8ger`并点击`Tools`-->`D8ger`-->`D8gerMore`
7171

72-
5.2 正则表达式模板, 代码彩蛋:
72+
6. 正则表达式模板, 代码彩蛋:
7373
- 任意空文本, 输入`regex`并点击`Tools`->`D8ger`->`D8gerMore`, 你会得到一点小惊喜
7474

75-
5.3 NASA模板(多行文本批处理), 代码彩蛋:
75+
7. NASA模板(多行文本批处理), 代码彩蛋:
7676
- 任意空文本, 输入`nasa`并点击`Tools`->`D8ger`->`D8gerMore`, 你会得到NASA操作手册
7777
- 按照NASA手册提示, 自定义配置并输入需要处理的多行文本, 然后你会得到一点小惊喜
7878

79-
5.4 驼峰-下划线-大写-首字母小写-小写, 一键循环转换
79+
8. 驼峰-下划线-大写-首字母小写-小写, 一键循环转换
8080
- 选中任意编辑状态下文件里的单词, 按下快捷键`alt` + `shift` + `cmd` + `U`, 你会发现选中单词转换了
8181
- 如果不是你想要的结果那就继续重复按下快捷键, 直到是你想要的为止
8282

83-
6. 你就得到如下默认配置信息
83+
9. 你就得到如下默认配置信息
8484
- 推荐你更改的配置项
8585
- `author`(你挖的坑可不许署我的名!)
8686
- `apiUrlPrefix`(接口url前缀应配置为项目接口统一Url前缀)
@@ -111,6 +111,7 @@
111111
112112
```
113113
解决方法
114+
0.升级到3.0及以上版本, 该问题不复存在
114115
1.由于IDEA文件采用VFS机制, 作为一个插件去采用监听文件我认为是不合算的
115116
2.此外, 编辑.properties文件时, 内容变更有时会消耗1-2分钟才会更新生效
116117
3.所以, 执行快捷键'cmd' + 's'强制刷新.properties文件, 即可解决

0 commit comments

Comments
 (0)