「コード・テンプレート」設定

「コード・テンプレート」設定ページを開く 「Java」>「コード・スタイル」>「コード・テンプレート」設定ページでは、新しく生成されるコードおよびコメントのフォーマットを構成することができます。

コードとコメント

「コードとコメント」ページには、コードを生成するアクションに使用されるコード・テンプレートが含まれています。各テンプレートには、その適用時に置換される変数が含まれています。すべてのテンプレートに使用可能な変数や、特定のテンプレートに使用可能な変数があります。

アクション

説明

デフォルト

編集...

「コード・テンプレート」ダイアログを開いて、現在選択しているコード・テンプレートを編集します。

n/a

インポート...

ファイル・システムからコード・テンプレートをインポートします。

n/a

エクスポート...

選択されたすべてのコード・テンプレートをファイル・システムにエクスポートします。

n/a

すべてエクスポート...

すべてのコード・テンプレートをファイル・システムにエクスポートします。

n/a

新規メソッドと型のコメントを自動的に追加

これを選択すると、新しく生成されるメソッドおよび型は、適切であれば自動的にコメント付きで生成されます。生成されるコメントのフォーマットは、コメント・テンプレートによって定義されます。

オフ

コメント・テンプレート

コメント・テンプレートには、コメント付き要素の標準 Javadoc タグ (@param、@return..) に置き換えられる変数 ${tags} を入れることができます。 さらに、「メソッドの上書き」コメントをテンプレート ${see_to_overridden} に入れることができます。

テンプレート名

指定

ファイル

新規ファイルのヘッダー・コメント。

このテンプレートは「新規 Java ファイル」テンプレートにおいて ${filecomment} として参照できます。

型

新しい型に関するコメント。

このテンプレートは「新規 Java ファイル」テンプレートにおいて ${typecomment} として参照できます。

フィールド

新しいフィールドに関するコメント。

コンストラクター

新しいコンストラクターに関するコメント。

メソッド

基本クラス内のメソッドをオーバーライドせず、他のどのメソッドにもその実行を委譲しない新規メソッドについてのコメント。

メソッドのオーバーライド

基本クラス内のメソッドをオーバーライドする新規メソッドについてのコメント。

デフォルトでは、このコメントは非 Javadoc コメントとして定義されます (Javadoc は、このコメントを上書きされたメソッドのコメントと置き換えます)。必要な場合は、これを実際の Javadoc コメントに変更できます。

メソッドの委譲 (Delegating method)

既存のメソッドにその実行を委譲する新規メソッドについてのコメント。

そのようなメソッドは、「ソース」>「委譲メソッドの生成...」アクションを使用して作成できます。

Getters

getter メソッドのコメント。

Setters

setter メソッドのコメント。

コード・テンプレート

テンプレート名

説明

新規 Java ファイル

新規 Java ファイルの作成時に「新規型」ウィザードで使用されます。

このテンプレートで、コメントを追加する場所を指定できます。このテンプレートには、それぞれ「型」および「ファイル」コメント・テンプレートの評価によって置き換えられる変数 ${typecomment} および ${filecomment} を含めることができます。

クラス本文

新規 Java クラスの作成時に「新規クラス (New Class)」ウィザードで使用されます。

インターフェースの本文

新規 Java インターフェースの作成時に「新規インターフェース (New Interface)」ウィザードで使用されます。

列挙型の本文

新規 Java 列挙型の作成時に「新規列挙型 (New Enum)」ウィザードで使用されます。

注釈の本文

新規 Java 注釈の作成時に「新規注釈」ウィザードで使用されます。

メソッド本文

「メソッド本文」テンプレートは、まだ一部のコードの機能を完了する必要がある本文を持つ新規メソッドの作成時に使用されます。

戻りステートメントまたは super 呼び出し (あるいはその両方) に解決される変数 ${body_statement} が含まれます。

コンストラクター本文

「コンストラクター本文」テンプレートは、本文での新規メソッドまたはコンストラクターの作成時に使用されます。

super 呼び出しに解決される変数 ${body_statement} が含まれます。

Getter 本文

「Getter 本文」テンプレートは、新規 getter メソッドの作成時に使用されます。

適切な return 文に解決される変数 ${body_statement} が含まれます。

Setter 本文

「Setter 本文」テンプレートは、新規 setter メソッドの作成時に使用されます。

適切な代入ステートメントに解決される変数 ${body_statement} が含まれます。

catch ブロック本文

「catch ブロック本文」テンプレートは、catch ブロック本文の作成時に使用されます。

変数 ${exception_type} および ${exception_var} を使用できます。

「コード・テンプレート」ダイアログ

ダイアログには、以下のフィールドおよびボタンがあります。

アクション

説明

説明

テンプレートの説明。

パターン

テンプレート・パターン

変数の挿入...

事前定義テンプレート特定変数のリストを表示します。

関連概念

テンプレート変数

関連参照

ソース・アクション
Java エディター
Java エディター設定
テンプレート設定