コードガイドライン
はじめに
この記事では、コーディング仕様とコーディングガイドラインを紹介します。
調査によると、ソフトウェア開発時間の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` をインポートします。
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 著作権の選択
詳細は、5つのオープンソースプロトコル(GPL、LGPL、BSD、MIT、Apache) - OSCHINA - 中国オープンソース技術交流コミュニティ を参照してください。
Javadoc ラベルの削除
`設定 > エディター > ファイルとコードテンプレート > インクルード` を選択します。
`ファイルヘッダー` に入り、Javadoc ラベルを削除します。
