nacos/style/codeStyle.md

Nacos

Code Style

Nacos code style Comply with Alibaba Java Coding Guidelines and code style file customized by Nacos community.

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

Guidelines

Alibaba-Java-Coding-Guidelines

阿里巴巴JAVA开发规约

community issue

Nacos Code Style File

Idea IDE

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.

Nacos代码风格文件在源代码下的style/nacos-code-style-for-idea.xml文件中，开发者可以将其倒入到Idea IDE中，并让IDE帮助您格式化代码。

Import Way/导入方式

Preferences/Settings --> Editor --> Code Style --> Schema --> Import Schema --> IntelliJ IDEA code style XML

eclipse IDE

Volunteer wanted.

待补充。

IDE Plugin Install（not necessary）

It is not necessary to install, if you want to find a problem when you are coding.

不是必须安装，如果你需要在开发的时候实时发现问题的话，你需要安装。

idea IDE

p3c

p3c-idea-plugin-install

p3c插件idea IDE上安装方法

checkstyle

chechstyle-idea-install

1. Preferences/Settings --> Other Settings --> Checkstyle OR Preferences/Settings --> Tools --> Checkstyle
2. Set checkstyle version at least 8.30 and scan scope All resource(including tests) in checkstyle plugin.
3. Import style/NacosCheckStyle.xml to checkstyle plugin.
4. Scan and check your modified code by plugin.

chechstyle插件idea安装

1. Preferences/Settings --> Other Settings --> Checkstyle 或者 Preferences/Settings --> Tools --> Checkstyle
2. 在checkstyle插件中设置checkstyle版本至少为8.30,并将扫描作用域设置为All resource(including tests)
3. 导入源代码下style/NacosCheckStyle.xml文件到checkstyle插件。
4. 用checkstyle插件扫描你修改的代码。

eclipse IDE

p3c

p3c-eclipse-plugin-install

p3c插件eclipse IDE上安装方法

checkstyle

Volunteer wanted.

待补充。

Acknowledgement Alibaba p3c