Skip to content

Commit a0227a0

Browse files
committed
Add text import guide in codeStyle.md to enhance code style import
1 parent 7c4cca4 commit a0227a0

File tree

3 files changed

+22
-13
lines changed

3 files changed

+22
-13
lines changed

style/NacosCheckStyle.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595
<property name="allowedAnnotations"
9696
value="Override, Test, Before, After, BeforeClass, AfterClass, Parameterized, Parameters"/>
9797
<property name="ignoreMethodNamesRegex" value="^set[A-Z].*|^get[A-Z].*"/>
98-
<property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
98+
<property name="tokens" value="METHOD_DEF, ANNOTATION_FIELD_DEF"/>
9999
</module>
100100
<module name="SingleLineJavadoc">
101101
<property name="ignoreInlineTags" value="false"/>

style/codeStyle.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,28 @@ Nacos code style Comply with Alibaba Java Coding Guidelines and code style file
55

66
Nacos的编码规范遵从于《阿里巴巴JAVA开发规约》和社区制定的Nacos代码风格文件。
77

8-
98
### Guidelines
109
[Alibaba-Java-Coding-Guidelines](https://alibaba.github.io/Alibaba-Java-Coding-Guidelines/)
1110

1211
[阿里巴巴JAVA开发规约](https://github.com/alibaba/p3c/blob/master/%E9%98%BF%E9%87%8C%E5%B7%B4%E5%B7%B4Java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C%EF%BC%88%E5%8D%8E%E5%B1%B1%E7%89%88%EF%BC%89.pdf)
1312

14-
### Nacos Code Style File
13+
[community issue](https://github.com/alibaba/nacos/issues/2992)
14+
15+
## Nacos Code Style File
16+
17+
### Idea IDE
1518

16-
#### Idea IDE
19+
Nacos Code Style file is `style/nacos-code-style-for-idea.xml` in source code. Developers can import it to Idea IDE and reformat code by IDE.
1720

18-
Nacos Code Style file is `style/NacosStyleForIdea.xml` in source code. Developers can import it to Idea IDE and reformat code by IDE.
21+
Nacos代码风格文件在源代码下的`style/nacos-code-style-for-idea.xml`文件中,开发者可以将其倒入到Idea IDE中,并让IDE帮助您格式化代码。
1922

20-
Nacos代码风格文件在源代码下的`style/NacosStyleForIdea.xml`文件中,开发者可以将其倒入到Idea IDE中,并让IDE帮助您格式化代码。
23+
#### Import Way/导入方式
2124

22-
#### eclipse IDE
25+
```
26+
Preferences/Settings --> Editor --> Code Style --> Schema --> Import Schema --> IntelliJ IDEA code style XML
27+
```
28+
29+
### eclipse IDE
2330

2431
Volunteer wanted.
2532

@@ -41,15 +48,17 @@ Volunteer wanted.
4148
#### checkstyle
4249
[chechstyle-idea-install](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea)
4350

44-
1. Set checkstyle version at least 8.30 and scan scope `All resource(including tests)` in checkstyle plugin.
45-
2. Import `style/NacosCheckStyle.xml` to checkstyle plugin.
46-
3. Scan and check your modified code by plugin.
51+
1. Preferences/Settings --> Other Settings --> Checkstyle
52+
2. Set checkstyle version at least 8.30 and scan scope `All resource(including tests)` in checkstyle plugin.
53+
3. Import `style/NacosCheckStyle.xml` to checkstyle plugin.
54+
4. Scan and check your modified code by plugin.
4755

4856
[chechstyle插件idea安装](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea)
4957

50-
1. 在checkstyle插件中设置checkstyle版本至少为8.30,并将扫描作用域设置为`All resource(including tests)`
51-
2. 倒入源代码下`style/NacosCheckStyle.xml`文件到checkstyle插件。
52-
3. 用checkstyle插件扫描你修改的代码。
58+
1. Preferences/Settings --> Other Settings --> Checkstyle
59+
2. 在checkstyle插件中设置checkstyle版本至少为8.30,并将扫描作用域设置为`All resource(including tests)`
60+
3. 导入源代码下`style/NacosCheckStyle.xml`文件到checkstyle插件。
61+
4. 用checkstyle插件扫描你修改的代码。
5362

5463
### eclipse IDE
5564

0 commit comments

Comments
 (0)