私は開発者ではないものの、日々E2Eテストの自動化などでコードを書いています。
複数人で自動テストのコードを書くことも多いのですが、そんなときに少し面倒なのがソースコードの整形。
メンバー内でコードレビューを行うのですが、インデントがどうとかコメントの書き方(見た目)がどうといった細かいところまで人間が見るのは面倒。もっとコードの内容や処理の内容のほうのレビューにパワーを割きたい。
なので、そういったコードの整形に関しては、IDE側で自動でやらせましょう。設定をメンバー皆で共有すれば、個人による差はなくなります。
Eclipseでソースの保存時にコードを自動で整形させる
設定>Java>エディター>保管アクション をひらきます。
「保管時に選択したアクションを実行」「ソース・コードのフォーマット」にチェックを入れます。
オススメはすべての行をフォーマットするほうです。
これで保存時に自動でフォーマットしてくれるようになりました。
が、フォーマット時のルールについて細かく設定したい場合もありますよね。
設定>Java>コード・スタイル>フォーマッター を開きます。
デフォルトでいくつかプロファイルが入っているので、そこから選ぶのでもOKですし、自分で細かく設定したい場合には「編集」を選択。
新規よりは既にあるものを好みに応じて変更するほうがはやいです。
ここではJavaDocの@params後の改行有無など、かなり詳細な設定が可能。チームメンバーの意見も聞きつつ、皆が読みやすいようなフォーマットを設定しましょう。