跳至主要内容
版本: 5.0

代码规范

介绍​

本文介绍了编码规范和编码指南。

研究表明，80% 的软件开发时间都花在了软件维护上，包括源代码解释、源代码重构、源代码维护等。

达成一致并执行代码规范和指南可以帮助提高代码可读性，维护开发团队对代码的拥有权，

帮助工程师快速深入地理解新代码，简化维护成本。

IDEA 编程模板​

以下指南将指导您在 IDEA 中导入 rmq_codeStyle.xml 编码规范文件和 Apache.xml 贡献许可文件。

导入代码风格​

1. 文件路径: rocketmq/style/rmq_codestyle.xml

2. Apple OS 导入: IntelliJ IDEA > 文件 > 设置 > 编辑器 > 代码风格 进入 代码风格，选择 管理 > 导入 导入 rmq_codestyle.xml 并将其命名为 方案

3. Windows OS 导入: IntelliJ IDEA > 文件 > 设置 > 编辑器 > 代码风格 进入 代码风格，选择 显示方案操作 > 导入方案 > Intellij IDEA 代码风格 XML 导入 rmq_codestyle.xml

1656682140788

4. 导入的 rmq_codeStyle.xml 指定了代码的缩进格式、命名约定、标准 Java 约定等

5. 设置 IDEA 后，代码会自动重新格式化以通过 Travis CI 的代码风格验证

导入 Apache V2​

1. 文件路径: rocketmq/style/copyright/Apache.xml

2. 导入: IntelliJ IDEA > 文件 > 设置 > 编辑器 > 版权 > 版权配置文件 进入 版权配置文件，选择 导入 导入 Apache.xml

1656683960857

3. 许可证: Apache 许可证 2.0 版

1656684219109

有关详细信息，请参阅 五种开源协议（GPL、LGPL、BSD、MIT、Apache） - OSCHINA - 中国开源技术交流社区

删除 Javadoc 标签​

  1. 选择 设置 > 编辑器 > 文件和代码模板 > 包含

  2. 进入 文件头，从中删除 Javadoc 标签

1656684039505