Eclipse コード・テンプレートを作成する方法

目次

コード・テンプレートとは

Eclipseがコードを自動生成するときのひな型(テンプレート)を定義する仕組みです。

開発者が一から書かなくても、ある程度決まった形式のコードを自動で埋め込んでくれます。

 

使用例

・メソッドのコメント(Javadoc)を自動生成する際のフォーマット

・toString()メソッドやget/setメソッドを自動生成する際のコードの形

・クラス作成時に自動で書かれるコメントヘッダー

 

テンプレートの例

/**
 * ${file_name}
 * 作成日: ${date}
 * 作成者: ${user}
 */

${file_name}, ${date}, ${user} は Eclipseが置き換えてくれます。

 

利用できる変数の例(プレースホルダ)

${user} ユーザー名
${date} 作成日
${time} 作成時刻
${project_name} プロジェクト名
${package_name} パッケージ名

コード・テンプレートを作成する

1.「ウィンドウ」>「設定」をクリックします。

    

 

2.「Java」>「コード・スタイル」>「コード・テンプレート」をクリックします。
右側にコード・テンプレートが表示されます。

 

3.例としてクラスの上に表示されるテンプレートを作成します。
「コメント」>「タイプ」>「編集」をクリックします。

 

4.テンプレートを編集します。
"コメントTEST1です"を追記し、変数の${date}を追加しました。
変数は、「変数の挿入」ボタンから選択できます。

 

以下は、「変数の挿入」ボタンをクリックした時に表示される変数の一覧です。

 

5.作成したコメントを確認するため新規でクラスを作成します。
「コメントの生成にチェック」を入れます。

 

6.生成されたソースコードです。
クラスの上に作成したコメントが表示されています。

関連の記事

Eclipse 行番号の表示方法
Eclipse フォントの大きさ/フォントを変える方法
Eclipse タブや空白の表示設定方法
Eclipse 文字コードの設定を変更する方法
Eclipse パンくずリストの表示と非表示の方法

△上に戻る