ファイルテンプレート
ファイルテンプレートは、プロジェクトツリーのコンテキストメニューのメニューまたは新規セクションを使用して作成する新しいファイルの既定の内容の仕様です。
作成するファイルの種類に応じて、テンプレートは、その種類のすべてのファイルに期待される初期コードとフォーマットを提供します (業界または言語の標準、企業ポリシー、その他の理由による)。例: 定型コード、作成者に関するメタ情報など。
IntelliJ IDEA は、新しいファイルを作成するときに提案される、サポートされているすべてのファイルタイプに対して事前定義されたテンプレートを提供します。推奨されるファイルタイプのセットは、モジュールと構成、プロジェクトツールウィンドウ内の現在の場所のプロパティによって異なります。例: IntelliJ IDEA は、Java ソースまたはテストディレクトリの外に Java クラスファイルを作成することを推奨しません。詳細については、「コンテンツルート」を参照してください。
例: プロジェクトツールウィンドウでディレクトリを右クリックし、新規を選択する (または Alt+Insert を押す) と、このコンテキストで作成できるファイルのリストが表示されます。これらのファイルには、設定で構成された対応するファイルテンプレートがあります。
ファイルテンプレートの管理と構成
Ctrl+Alt+S を押して設定を開き、を選択します。
詳細は、ファイルおよびコードテンプレートを参照してください。
デフォルトでは、テンプレートのリストには、IntelliJ IDEA によって提供される事前定義されたテンプレートのみが含まれています。それらのいくつかは内部的なものです。つまり、削除したり名前を変更したりすることはできません。IntelliJ IDEA は、内部テンプレートの名前を太字で示しています。変更したテンプレートの名前、および手動で作成したカスタムテンプレートは、青色で表示されます。
次の手順では、ファイルテンプレートを作成する方法について説明します。インクルードテンプレートの作成にも同様の手順を使用できます。
新しいファイルテンプレートを作成する
Ctrl+Alt+S を押して設定を開き、を選択します。
スキームリストを使用して、ファイルテンプレートが適用されるスコープを選択します。
デフォルト : IDE レベルで作成されたファイルテンプレート。これらのテンプレートは、現在の IDE インスタンスで開くすべてのプロジェクトで使用できます。特定のプロジェクトに関係なく、好みの個人用テンプレートとして使用します。IntelliJ IDEA は、グローバルテンプレートを fileTemplates の IDE 構成ディレクトリに保存します。
プロジェクト : 現在のプロジェクトに固有のファイルテンプレート。これらのテンプレートは、このプロジェクトで作業するすべてのユーザーが利用できます。IntelliJ IDEA は、.idea/fileTemplates のプロジェクトフォルダーに保存します。
ファイルタブで、
をクリックし、テンプレート名、ファイル拡張子、結果のファイルの名前、テンプレートの本体を指定します。変更を適用し、ダイアログを閉じます。
既存のファイルテンプレートをコピーする
Ctrl+Alt+S を押して設定を開き、を選択します。
ファイルタブで、
をクリックし、必要に応じてテンプレートの名前、ファイル拡張子、本文を変更します。変更を適用し、ダイアログを閉じます。
ファイルをテンプレートとして保存する
エディターでファイルを開きます。
メインメニューで、に移動します。
「ファイルをテンプレートとして保存」ダイアログで、新しいテンプレート名と拡張子を指定し、必要に応じて本文を編集します。ファイルテンプレートで使用される構文の詳細については、「構文」を参照してください。
ファイル名 : 必要に応じて、このテンプレートから作成されるファイルの名前を指定します。デフォルトでは、IntelliJ IDEA はファイルを追加するときにユーザーに名前の入力を求めます。特定の名前をハードコードしてプロンプトを完全に回避したり、使用可能な変数からテンプレートを作成したりできます。例: 指定した名前を使用して、ファイル作成時に選択したディレクトリの 1 つ上のディレクトリに置く方法を次に示します:
../${NAME}スタイルに応じて整形 : このファイルタイプに定義されたコードスタイルに従って、このテンプレートに基づいて生成されたコンテンツを再フォーマットします。
ライブテンプレートを使用可能にする : ファイルテンプレート内にライブテンプレートを挿入します。Velocity エスケープ構文を使用して、ライブテンプレート変数をファイルテンプレートに含めます（例:
#[[ $MY_VARIABLE$ $END$ ]]#）。
変更を適用し、ダイアログを閉じます。
構文
ファイルテンプレートは Velocity テンプレート言語 (英語)(VTL) を使用します。これには、次の構成が含まれます。
プレーンテキストはそのままレンダリングされます。
値に置き換えられる変数。例:
${NAME}は、ファイルを追加するときにユーザーが指定した名前を挿入します。#parse、
#set、#ifなどを含むさまざまなディレクティブ。
$ または # の入力を開始して、使用可能な変数およびディレクティブの補完候補を参照します。
詳細については、VTL リファレンスガイド(英語)を参照してください。
次の例は、IntelliJ IDEA で Java クラスを作成するためのデフォルトテンプレートを示しています。
このテンプレートでは:
#ifディレクティブは、パッケージ名が空でないかどうかをチェックし、空でない場合は、${PACKAGE_NAME}変数として渡されたパッケージステートメントに名前を追加します。#parseディレクティブは、Ctrl+Alt+S 設定のエディター | ファイルおよびコードテンプレートページのインクルードタブで使用できるFile Header.javaという名前の別のテンプレートの内容を挿入します。テンプレートは、
${NAME}変数（新しいファイルの名前）として渡された名前を持つパブリッククラスを宣言します。
新しい Java ファイルを作成すると、このテンプレートは次のような内容のファイルを生成します。
関連ページ：
コンテンツルート
IntelliJ IDEA のコンテンツは、ソースコード、ビルドスクリプト、テスト、ドキュメントを含むファイルのグループです。これらのファイルは通常、階層構造になっています。最上位フォルダーはコンテンツルートと呼ばれます。モジュールには通常、1 つのコンテンツルートがあります。コンテンツルートを追加することができます。たとえば、コードがコンピューター上の別の場所に格納されている場合には、これは便利です。同時に、モジュールはコンテンツルートなしで存在することができます。この場合、他のモジュールの依...
ファイルおよびコードテンプレート
このページを使用して、ファイルテンプレートを表示、編集、作成します。スキームファイルテンプレートを適用するスコープを選択します。デフォルト: IDE レベルで作成されたファイルテンプレート。これらのテンプレートは、現在の IDE インスタンスで開くすべてのプロジェクトで使用できます。特定のプロジェクトに関係なく、好みの個人用テンプレートとして使用します。IntelliJ IDEA は、グローバルテンプレートを fileTemplates の IDE 構成ディレクトリに保存します。プロジェクト: 現在の...
テンプレート内の再利用可能なコンテンツ
テンプレートのインクルードは、ディレクティブによって他のテンプレートに挿入される再利用可能なコード（標準ヘッダー、コピーライトステートメントなど）を定義するために使用されます。ディレクティブの構文は次のとおりです。#parse("<include_template_name.extension>") 例:#parse("File Header.java") このように他のテンプレートで参照できるテンプレートは、設定のエディター | ファイルおよびコードテンプレートページのインクルードタ...
ライブテンプレート変数
ライブテンプレートの略語を展開すると、その変数は値を入力できる入力フィールドとして表示されるか、値に置き換えられます。これらは、変更可能なデフォルト値または関数を使用して計算された値です。テンプレート内で変数を宣言するには、次の形式を使用します: 式では、ドル文字を開閉せずに変数名を使用します（例:）。式を使用して各変数を定義し、式が評価に失敗した場合のデフォルト値を提供します。この式には、次の構成が含まれる場合があります。二重引用符で囲まれた文字列定数、ライブテンプレートで定義されている他の変数...
ファイルテンプレート変数
ファイルテンプレートには変数を含めることができます。変数は、テンプレートが適用されるときに値に置き換えられます。変数は、ドル記号で始まり、その後に変数名が続く文字列です。変数名は、オプションで波括弧で囲むことができます。たとえば、とは同じ変数の異なる表記法です。事前定義された変数とカスタム変数は、テンプレート本体とファイル名で使用できます。例: テンプレートのファイル名フィールドにと入力した場合、4 月に作成すると、結果のファイルの名前はになります。ここで、は事前定義された変数です。代わりにカス...
コード補完
このセクションでは、コーディングプロセスのスピードアップを可能にするコンテキスト対応コード補完のさまざまなテクニックについて説明します。基本補完：基本コード補完は、可視性スコープ内のクラス、メソッド、フィールド、キーワードの名前を完成させるのに役立ちます。コード補完を呼び出すと、IntelliJ IDEA はコンテキストを分析し、現在のキャレット位置から到達可能な選択肢を提案します (提案にはライブテンプレートも含まれます)。基本コード補完がフィールド、パラメーター、変数宣言の一部に適用されて...