# qing-framework

**Repository Path**: qinggroup/qing-framework

## Basic Information

- **Project Name**: qing-framework
- **Description**: 轻框架
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2016-08-04
- **Last Updated**: 2021-04-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#qing-framework

## 代码格式规范

在 qing-framework 的开发中，发现之前的代码非常的脏乱差，为了改变这种情况，特别引入静态分析工具 CheckStyle 进行格式检查，同时采用 [谷歌开发规范](https://segmentfault.com/a/1190000002761014) 中的编码格式约定，目标使每个人写出来的代码保持一致，从而保证工程代码的一致性

# Eclipse 设置

导入项目根目录的文件 eclipse-java-google-style.xml，此文件设定 Eclipse 中的 Java 排版格式

![eclipse_import_google_java_style](docs/code_style/eclipse_import_google_java_style.png)


设定导入语句顺序，导入语句顺序遵循谷歌规范，按照字母顺序，静态导入独立放在最前面。com 包在前，随后是 org包，最后是 java.* javax.*

![eclipse_set_import_order](docs/code_style/eclipse_set_import_order.png)


安装 CheckStyle 插件

![open_the_markspace](docs/code_style/open_the_markspace.png)

![install_checkstyle_plugin_via_markspace](docs/code_style/install_checkstyle_plugin_via_markspace.png)


为每个项目激活一下 CheckStyle 实时检查，这样在文件编辑保存时即可发现问题

![eclipse_active_checksytle](docs/code_style/eclipse_active_checksytle.png)

好了，现在就可以进行开发工作，同时写出漂亮一致的代码