程式碼規範

簡介

本文將介紹編碼規範和編碼指南。

研究顯示，80% 的軟體開發時間花在軟體維護上，包括原始碼詮釋、原始碼重構、原始碼維護等。

同意並強制執行程式碼規範和指南，有助於改善程式碼可讀性，維護開發團隊的程式碼所有權，

幫助工程師快速深入了解新程式碼，並簡化維護成本。

IDEA 程式設計範本

以下指導您在 IDEA 中匯入 rmq_codeStyle.xml 編碼規範檔案和 Apache.xml 貢獻授權檔案。

匯入程式碼樣式

1.檔案路徑：rocketmq/style/rmq_codestyle.xml

2.Apple OS 匯入：IntelliJ IDEA > 檔案 > 設定 > 編輯器 > 程式碼樣式 進入 程式碼樣式，選擇 管理 > 匯入 匯入 rmq_codestyle.xml 並命名為 Scheme

3.Windows OS 匯入：IntelliJ IDEA > 檔案 > 設定 > 編輯器 > 程式碼樣式 進入 程式碼樣式，選擇 顯示 Scheme 動作 > 匯入 Scheme > Intellij IDEA 程式碼樣式 XML 匯入 rmq_codestyle.xml

4.匯入的 rmq_codeStyle.xml 規定了程式碼的縮排格式、命名慣例、Java 標準慣例等等

5.設定 IDEA 後，程式碼會自動重新格式化，通過 Travis CI 的程式碼樣式驗證

匯入 Apache V2

1.檔案路徑：rocketmq/style/copyright/Apache.xml

2.匯入：IntelliJ IDEA > 檔案 > 設定 > 編輯器 > 版權 > 版權設定檔 進入 版權設定檔，選擇 匯入 匯入 Apache.xml

3.授權：Apache License, Version 2.0

選擇 Apache 版權

參考 五種開源協議（GPL、LGPL、BSD、MIT、Apache） - 開源中國 - 中國開源技術交流社區 瞭解詳情

移除 Javadoc 標籤

1. 選擇 設定 > 編輯器 > 檔案和程式碼範本 > 包含

2. 進入 檔案標頭，移除其中的 Javadoc 標籤