概要
- Eclipseで開発している時に自動でコーディング規約を適用して保存する方法の備忘録
背景
- ソースコードレビュー時にコーディング規約違反を指摘するのが馬鹿らしい
- ソースコードレビューの時間はもっと別のことにリソースを集中したい
- プログラミングの癖は十人十色なので、気を付けてもコーディング規約違反はでちゃう
解決策
- Eclipseで自動で保存する時に修正してもらう(今更かよ!)
- Googleがコーディング規約を公開している。例えば、Javaだとこんな感じ
- Eclipseにはフォーマット機能(ショートカットキー:Ctrl + Shift + F)があり、指定したコーディング規約(xml形式でインポートされているもの)にしたがって、修正可能。
環境設定
- Eclipse 4.7 Oxygen(Pleiades)
- Java 1.8
- Git
手順
- ウィンドウ→パースペクティブ→パースペクティブを開く→その他→Git
- Gitリポジトリーの複製→URIの複製→URI:「https://github.com/google/styleguide.git」 を入力→次へ→次へ→「ローカル宛先」:ディレクトリーは任意の宛先を入力→完了
- ウィンドウ→設定→Java→コード・スタイル→フォーマッターでインポートをクリックし、2.でCloneしたディレクトリから「eclipse-java-google-style.xml」を選択→「適用して閉じる」
- ウィンドウ→設定→Java→エディター→保管アクション→「保管時に選択したアクションを実行」にチェック→「ソース・コードのフォーマット」にチェック→「適用して閉じる」
- (既に作成済のソースコードがある場合は、)プロジェクトを右クリック→ソース→フォーマット で全ファイルにフォーマットが掛けられる
- 以降は、ソースコードを保存する度にフォーマット機能が働く