連載
» 2003年10月21日 10時00分 公開

JavaTips 〜Eclipse活用編:コーディング規約に従いコードを自動整形する

[山田祥寛,@IT]

 「コーディング規約に従わないコードを検索する」では、あらかじめ用意したコーディング規約に沿って、既存のソースコードをチェックする方法について紹介しました。しかし、行えることはチェックを自動化するところまでです。リストアップされたエラー、警告項目を実際に修正するのは、やはり人間の手で行わなければに委ねなければならないことになってしまいます。

 これはとても面倒なことです。こういった単純な作業は、できることならばツールに任せてしまいたいところです。そこで本稿では、Eclipseが標準で備える「コード・フォーマッター」の機能を紹介することにします。「コード・フォーマッター」では、あらかじめコーディングの規則を定めておくことで既存コードの一括整形が可能となります。

操作手順

(1)「コード・フォーマッター」の設定を行う

 メニューバーから[ウィンドウ]→[設定]を選択すると、「設定」ダイアログが開くので、左ツリーから[Java]→[コード・フォーマッター]を選択します。「改行」「行分割」「スタイル」の3つのタブにはそれぞれ以下の画面のようなメニューがあります。

「改行」タブのページ 「改行」タブのページ
「行分割」タブのページ 「行分割」タブのページ
「スタイル」タブのページ 「スタイル」タブのページ

 それぞれのタブにおける設定可能な項目は、以下のとおりです。

タブ 設定項目 概要
改行 左中カッコの前に改行を挿入 ifやforなどのブロックを開始する左中括弧({)の前に改行を挿入
制御ステートメントに改行を挿入 else ifやcatch、finally、whileのような制御ステートメントの前に改行を挿入
ブランク行をすべてクリア 空行を消去
“else if”の間に改行を挿入 “else”と“if”との間に改行を挿入
空ブロック内に改行を挿入 空のブロック({})の間に改行を挿入
行分割 行の最大長 指定値より長い行は、適当な個所でラップ処理
スタイル 割り当てのコンパクト 変数名と代入演算子との間のスペースを除去
キャスト後にスペースを挿入 (String)や(int)のようなキャスト構文の後方にスペースを挿入
インデント用にスペースではなくタブを挿入 ブロック単位のインデントを示すためにタブ文字を使用
キャスト後にスペースを挿入 (String)や(int)のようなキャスト構文の後方にスペースを挿入
インデント用にスペースではなくタブを挿入 ブロック単位のインデントを示すためにタブ文字を使用
インデント・レベルを示すスペースの数 インデントにスペースを利用する場合のスペースの数

 それぞれの適用内容は、設定画面下部の凡例を参照することで確認できます。

(2)「コード・フォーマッター」を適用する

 エディタ上で「コード・フォーマッター」を適用したい部分を選択し、メニューバーより[ソース]→[フォーマット]とします。(1)での設定内容に従い、コードが整形されれば成功です。

Copyright © ITmedia, Inc. All Rights Reserved.

RSSについて

アイティメディアIDについて

メールマガジン登録

@ITのメールマガジンは、 もちろん、すべて無料です。ぜひメールマガジンをご購読ください。