IntelliJ IDEA 2020.3 ヘルプ

ファイルテンプレート

ファイルテンプレートは、作成する新しいファイルのデフォルトコンテンツの仕様です。作成するファイルのタイプに応じて、テンプレートは、そのタイプのすべてのファイルで期待される初期コードとフォーマットを提供します(業界または言語の標準、企業ポリシー、またはその他の理由による)。例: これは、定型コード、作成者に関するメタ情報などです。

IntelliJ IDEA は、新しいファイルを作成するときに提案される、サポートされているすべてのファイルタイプの定義済みテンプレートを提供します。推奨されるファイルタイプのセットは、モジュールと構成、プロジェクトツールウィンドウの現在の場所のプロパティによって異なります。例: IntelliJ IDEA は、Java ソースまたはテストディレクトリの外部に Java クラスファイルを作成することを提案しません。詳細については、コンテンツルートを参照してください。

例: プロジェクトツールウィンドウでディレクトリを右クリックして新規を選択すると、このコンテキストで作成できるファイルのリストが表示されます。これらのファイルには、設定で構成された対応するファイルテンプレートがあります。

List of file templates when creating a new file

ファイルテンプレートを管理および構成するには、設定 / 環境設定 Ctrl+Alt+Sエディター | ファイルおよびコードテンプレートページを開きます。

  • デフォルトスコープは、任意のプロジェクトのワークスペース全体に適用されるテンプレートを制御します。それらは fileTemplatesIDE 構成ディレクトリに保存されます。

  • プロジェクトスコープは、現在のプロジェクトにのみ適用されるテンプレートを制御します。それらは .idea/fileTemplates のプロジェクトフォルダーに保存されます。これらのテンプレートは、チームメンバー間で共有できます。

デフォルトでは、テンプレートのリストには IntelliJ IDEA が提供する定義済みのテンプレートのみが含まれています。そのうちのいくつかは内部的なものです。つまり、削除や名前の変更はできません。内部テンプレートの名前は太字で示されています。手動で作成したカスタムテンプレートだけでなく、変更したテンプレートの名前も青色で表示されます。

IntelliJ IDEA はいくつかのタイプのテンプレートを使用し、以下のタブに分かれています:

  • ファイルタブには、新しいファイルを作成するためのファイルテンプレートが含まれています。

  • インクルードタブには、ファイルテンプレートに挿入するための再利用可能なコンテンツが含まれています(たとえば、特定のヘッダーが複数のファイルテンプレートに適用される場合)。

  • コードタブには、IntelliJ IDEA がさまざまな構成を生成するために使用するコードフラグメント(スニペット)の内部テンプレートが含まれています。このタブで使用可能なスニペットを編集できますが、新しいスニペットを作成することはできません。

    カスタムコードスニペットを作成するには、ライブテンプレートを使用します。

  • その他タブには、さまざまなアプリケーションサーバーおよびフレームワークで使用されるテンプレートが含まれています。このタブで既存のビルトインテンプレートを編集できますが、新しいテンプレートは作成できません。

次の手順では、ファイルテンプレートを作成する方法について説明します。インクルードテンプレートの作成にも同様の手順を使用できます。

新しいファイルテンプレートを作成する

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | ファイルおよびコードテンプレートを選択します。

  2. ファイルタブで、the Create Template button をクリックして、テンプレートの名前、ファイル拡張子、本文を指定します。

  3. 変更を適用し、ダイアログを閉じます。

既存のファイルテンプレートをコピーする

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | ファイルおよびコードテンプレートを選択します。

  2. ファイルタブで、the Copy Template button をクリックし、必要に応じてテンプレートの名前、ファイル拡張子、本文を変更します。

  3. 変更を適用し、ダイアログを閉じます。

ファイルをテンプレートとして保存する

  1. エディターでファイルを開きます。

  2. メニューからツール | ファイルをテンプレートとして保存を選択してください。

  3. ファイルをテンプレートとして保存ダイアログで、新しいテンプレート名を指定し、必要に応じて本文を編集します。

  4. 変更を適用し、ダイアログを閉じます。

構文

ファイルとコードのテンプレートは Velocity テンプレート言語(英語)(VTL)を使用します。これには、次の構成が含まれています。

  • そのままレンダリングされる固定テキスト(マークアップ、コード、コメントなど)。

  • 変数。値に置き換えられます。

  • #parse#set#if などを含むさまざまなディレクティブ。

詳細は、VTL リファレンスガイド(英語)を参照してください。

次の例は、IntelliJ IDEA で Java クラスを作成するためのデフォルトテンプレートを示しています。

#if (${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end #parse("File Header.java") public class ${NAME} { }

このテンプレートでは:

  • #if ディレクティブは、パッケージ名が空でないかどうかをチェックし、空でない場合は、${PACKAGE_NAME} 変数として渡されたパッケージステートメントに名前を追加します。

  • #parse ディレクティブは、File Header.java という名前の別のテンプレートのコンテンツを挿入します。

  • テンプレートは、${NAME} 変数(新しいファイルの名前)として渡された名前を持つパブリッククラスを宣言します。

新しい Java ファイルを作成すると、このテンプレートは次のような内容のファイルを生成します。

package demo; /** * Created by IntelliJ IDEA. * User: John.Smith * Date: 6/1/11 * Time: 12:54 PM * To change this template use File | Settings | File and Code Templates. */ public class Demo { }

関連ページ:

コンテンツルート

IntelliJ IDEA のコンテンツは、ソースコード、ビルドスクリプト、単体テスト、ドキュメントを含むファイルのグループです。これらのファイルは通常、階層構造になっています。最上位のフォルダーはコンテンツルートと呼ばれます。モジュールには通常、1 つのコンテンツルートがあります。コンテンツルートを追加することができます。たとえば、コードがコンピューター上の別の場所に格納されている場合には、これは便利です。同時に、モジュールはコンテンツルートなしで存在することができます。この場合、他のモジュー...

高度な構成

使用可能な標準オプションに加えて、IntelliJ IDEA を使用すると、基盤となるプラットフォームと Java ランタイムの低レベルの構成を実行できます。これにより、予期しない問題が発生する可能性があり、何をしているのかわからない場合は、IntelliJ IDEA のインストールが動作不能になる可能性があります。解決しようとしている問題の解決に役立つオプションと値に関する指示については、JetBrains サポートにお問い合わせください。JVM オプション:IntelliJ IDEA は、...

インテンションアクション

エディターで作業するときに、IntelliJ IDEA はコードを分析し、コードを最適化する方法を検索し、潜在的な問題と実際の問題を検出します。IDE がコードを変更する方法を見つけるとすぐに、エディターの現在の行の横に黄色いバルブアイコンが表示されます。このアイコンをクリックすると、このコード単位で使用可能なインテンションアクションを表示できます。インテンションアクションは、警告から最適化の提案まで、幅広い状況をカバーします。インテンションの完全なリストを表示し、設定 / 環境設定ダイアログ...