前回、eclipse(Pleiades)をダウンロードし、起動するところまで説明しました。

今回は、インデントやタブ・スペース、文字化け回避などおすすめの設定について説明していきます。

軽視されがちですが、中には保守性や開発効率をアップする設定もあるのでとても大事です。

また、チームで設定を共有するためのエクスポート・インポートについても紹介します。

実行環境はWindows10、eclipseのバージョンは2018年3月時点で最新の4.7 Oxygenを使っています。

「設定メニューの開き方」

elipse全体の設定は、

メニューの「ウィンドウ」→「設定」

 

プロジェクト単位の設定は、

プロジェクト・エクスプローラーから該当プロジェクトを選択し右クリック→「設定」

 

となります。

 

一般-ワークスペース

テキスト・ファイル・エンコード：UTF-8(デフォルト)

ソース中の日本語が文字化けしてしまうので、チームで開発する場合は必ず合わせましょう。
※OxygenはUTF-8がデフォルトになってます。

ビルド前に自動的に保存：ON

ビルド前に未保存のファイルを保存してくれます。

 

 

一般-エディター

空白を可視化する：ON(デフォルト)

誤って全角スペースを入力して原因不明のコンパイルエラーに陥るなんてつまらないミスが無くなります。

行番号を表示：ON(デフォルト)

ソースコードの左側に行番号がつきます。

「元に戻す」ヒストリーサイズ ：10000

「元に戻す」の限界を引き延ばします。大量に戻すときに記憶切れにならないように設定します。

現在行の強調表示：ON(デフォルト)

これはそのままの意味です。

 

Java-エディター

コンテンツアシスト-Javaの自動有効化トリガー：abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_

通常は「.」を入力するかctrl + スペースで候補が表示されますが、全ての入力のタイミングで候補が表示されるようになります。個人的にはかなり好きな設定です。

コンテンツアシスト-自動有効化遅延：50

入力してから候補が出てくるまでの時間です。早すぎず遅すぎずちょうど良い数値を設定しましょう。

保存アクション-ソース・コードのフォーマット：ON(すべての行をフォーマット)

ソースファイル保存時に自動でコードを整形してくれる機能を有効にします。

追加アクション：ON

チェックすることで「構成」ボタンから細かい設定が可能になります。

精査が面倒ですが、有用ですので検討してチームのメンバーで統一しましょう。

以下より詳細な設定内容です。

追加保存アクション-コードスタイル-if/while/for/doステートメントでブロックを使用：ON

if文などを記述した際に、自動的に{}ブロックを補ってくれます。

追加保存アクション-コードスタイル-‘for’ループを拡張へ変換：ON

for文を記述した際に、可読性の高い拡張forループ文に変換してくれます。

追加保存アクション-コードスタイル-式で括弧を使用：ON(必要な場合のみ)

複数の条件がある式が記述された際に、括弧を補ってくれます。

可読性が少し上がるかと思いますが、OFFでもいいと思います。

追加保存アクション-コードスタイル-関数型インターフェース・インスタンス：ON(可能な場合はラムダを使用)

インスタンスが関数型インターフェースだった際に、ラムダ式あるいは匿名クラスの記述に変換してくれます。

追加保存アクション-コード編成-末尾の空白を除去：ON

各命令の末尾に無意味な空白があった場合は削除してくれます。

追加保存アクション-コード編成-インデントの訂正：ON

インデントをきれいに整形してくれる機能ですが、可読性向上の為あえて余計にずらしたインデントも元に戻ってしまいますので、お好みで。

追加保存アクション-メンバーアクセス-フィールドアクセスにthis修飾子を使用：ON(必要な場合のみ)

thisはつけわすれることもありますし、可読性も上がるので良い設定だと思います。

追加保存アクション-メンバーアクセス-メソッドアクセスにthis修飾子を使用：ON(必要な場合のみ)

上記と同様です。

追加保存アクション-欠落コード-欠落している注釈を追加：ON(@Override、@DeprecatedもON)

オーバーライドが明示的になって可読性があがります。

追加保存アクション-不要なコード-未使用のインポートの除去：ON

使用していないインポート文がそのまま残り続けることがなくなります。

追加保存アクション-不要なコード-不要キャストの除去：ON

Boolean b= (Boolean) Boolean.TRUE;

のようなキャストを消去してくれます。

追加保存アクション-不要なコード-冗長な型引数の除去：ON

List<String> list = new ArrayList<String>();

のように”String”が冗長となっているのを右辺の”String”を消去してくれます。

 

Java-コンパイラー

コンパイラー準拠レベル：対象のバージョン(デフォルトは1.8)

この設定は必須です。

Javadoc-Javadocコメントを処理：ON

Javadocの入力を必須にし、未入力や形式誤りの場合にエラーや警告にすることができます。

Javadocの記載はついつい忘れてしまうこともありますし、面倒ですが保守性を考えたら設定しておいた方がいいです。

エラーや警告のレベルは以下から詳細に設定できます。

Javadoc-誤った形式のJavadocコメント：警告

入力値の形式を精査してくれます。

個人的にはエラーだと厳しすぎる気がするので警告がいいと思います。

少なくても気づくことはできますしね。

Javadoc-メンバーの可視性を次のように設定：private

個人的にはここはできるだけ厳しくした方がいいと思いますが、

作業負荷などを考えてチームでpublicやprotectedにするのもありかと思います。

Javadoc-タグ引数の検証：ON(不可視参照をレポート、使用すべきではない参照をレポートもON)

@paramや@throwsなどのタグ引数を記述した際に適切な入力値になっているか検証してくれます。

Javadoc-タグ記述の欠落：ON(全ての標準タグを検証)

例えば@paramなら引数に指定されている名前が必須となり記述されてなければエラーや警告となります。

Javadoc-未指定のJavadocタグ：警告

@paramなどのJavadocが未指定の場合にエラーや警告としてくれます。

ここも警告のほうがいいと思います。

Javadoc-メンバーの可視性を次のように設定：Private

どこまで必須にするかはチームで相談するといいと思います。

慣れれば苦じゃなくなるので個人的にはPrivateがいいと思います。

Javadoc-未指定のJavadocコメント：警告

そもそもクラスやメソッドのJavadocが未指定の場合にエラーや警告としてくれます。

ここも警告がいいと思います。

Javadoc-メンバーの可視性を次のように設定：Protected

クラスのフィールドやメソッドにJavadocをどのレベルで必須にするかの設定です。

クラスによってはprivateなメンバーが多く大変になるのでProtectedがいいかなと思います。

 

Java-コードスタイル

Booleanを戻すgetterに’is’接頭部を使用：ON

Booleanのgetterは一般的に”is + フィールド名”が多いと思いますので、ONにしておくと統一されていいと思います。

コード・テンプレート-コメント-ファイル(など)：編集ボタンからパターンを編集

Alt + Shift + J でJavadocコメントが付与されますが、そのデフォルト値を規定します。

例えば、メソッドを選んで編集ボタンを押し、パターンを以下のように編集します。

/**
* メソッドの説明：
* @author ${user}
* @since ${date}
* ${tags}
*/

このようにすることで、メソッド名にカーソルを合わせた状態で、Alt + Shift + J を押すとログイン中のユーザーの名前や現在日付が自動で付与され、引数や戻り値などがある場合は

@paramや@returnが自動で付与されます。

これをメソッド同様に他も定義すればJavadocの記述による負担はかなり軽減されると思います。

 

 

Javascript-エディター

 コンテンツ・アシスト-自動有効化を使用可能にする：ON

Javaのコンテンツアシストと同様に文字を入力すると候補が表示されます。

これは設定しておいた方がいいです。

 コンテンツ・アシスト-自動有効化遅延：50

これも同様に入力してから候補が出てくるまでの時間です。お好みで調整してください。

コンテンツ・アシスト-Javascriptの自動有効化トリガー：.abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_

これも同様に１文字入力するたびに候補が出てくるようにします。

入力-訂正位置で自動的に挿入-波括弧：ON

波括弧が必要な場合に自動で補ってくれます。

保存アクション-保存時に選択したアクションを実行：ON

保存のタイミングでフォーマットしてくれる機能です。

保存アクション-追加アクション：ON

「構成ボタン」を押すことで保存アクションを定義できます。

追加保存アクション-コードスタイル-if/while/for/doステートメントでブロックを使用：ON(常時)

if文などを使用した際に、{}が不要なパターンでも付与するようにします。

こちらの方が統一感があるのでいいと思います。

追加保存アクション-コードスタイル-条件を括弧で囲む：ON(必要な場合のみ)

式の条件で括弧が必要な場合のみに括弧をが残るようにしてくれます。

追加保存アクション-不要なコード-未使用のローカル変数を除去：ON

使用していない変数を削除してくれます。

追加保存アクション-コード編成-末尾の空白を除去：ON(全ての行)

不要な命令文末の空白を削除してくれます。

 

Javascript-バリデーター

JSDoc-Jsdocコメントの処理：ON

JSDocの記述内容を精査してくれます。

JSDoc-誤った形式のJsdocコメント：警告

記述形式が間違っていた場合に警告やエラーにできます。

エラーはやりすぎかと思いますので、警告にしています。

JSDoc-未指定のJsdocタグ：警告

functionに引数がある場合にJsdocタグが記述されていないと警告を出します。

JSDoc-タグ内のエラーをレポート：ON

エラー内容をレポートしてくれます。

JSDoc-未指定のJsdocコメント：警告

functionにJsdocコメント自体がない場合に警告を出します。

JSDoc-エラー/警告-Javascriptセマンティクス検証を使用可能にする：ON

チェックすることである程度のロジックチェックをしてくれます。

検証の内容と警告・エラー・無視のどれにするかは「次のJavaSciprtバリデーター・オプションの問題重大度レベルを選択」から指定します。

 

JSON

JSONを使って通信する場合はこのあたりの設定しておいたほうがいいと思います。

JSONファイル-エディター-コンテンツアシスト-単一候補を自動的に挿入、自動的に候補を表示：ON

コンテンツアシストは入れておいた方がいいと思います。

JSONファイル-エディター-検証-構文検証を使用可能にする、スキーマ検証を有効にする：ON

実行前に悪いところは気づけた方がいいのでONにしましょう。

 

XML

コンテンツアシストはデフォルトでONになっているので省略します。

XMLファイル-検証-マークアップ検証を使用可能にする：ON

ONにすることで終了タグが欠如していたり文法が間違っている場合はエラーとなります。

 

実行/デバッグ

コンソール-コンソールのバッファー・サイズ：お好みで

コンソールに出力されるバッファーサイズです。

少ないと古い出力からどんどん消えていくので、エラーを追っていくときに見えなくなってしまうことがあります。

筆者は300000にしてます。

 

eclipse.ini

-Dfile.encoding=utf-8

いままでの設定メニューとは違いますが、System.out.println等でコンソールに日本語を出力した際に文字化けしないようにする設定です。

必ず設定した方がよいので載せておきます。

文字コードはチームの規定に沿ってきめてください。

 

 

以上となります。