跳到主要内容
版本: 5.0

代码规范

简介​

本文向您介绍代码规范和编码指南。

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

统一并执行代码规范和指南有助于提高代码可读性，维护开发团队对代码的所有权，

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

IDEA 编程模板​

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

导入代码风格​

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

2.Apple OS 导入: IntelliJ IDEA > File > Settings > Editor > Code Style 进入Code Style，选择Manage > Import导入rmq_codestyle.xml并命名为Scheme

3.Windows OS 导入: IntelliJ IDEA > File > Settings > Editor > Code Style 进入Code Style，选择Show Scheme Actions > Import Scheme > Intellij IDEA code style 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 > File > Settings > Editor > Copyright > Copyright Profiles 进入Copyright Profiles，选择import导入Apache.xml

1656683960857

3.许可协议: Apache License, Version 2.0

1656684219109

参考 五种开源协议(GPL,LGPL,BSD,MIT,Apache) - OSCHINA - 中文开源技术交流社区 获取详细信息

移除 Javadoc 标签​

  1. 选择Settings > Editor > File and Code Templates > Includes

  2. 进入File Header，从中移除Javadoc标签

1656684039505