AppCode 2023.1 ヘルプ

ファイルテンプレート

ファイルテンプレートは、作成する新しいファイルのデフォルトコンテンツの仕様です。作成するファイルのタイプに応じて、テンプレートは、そのタイプのすべてのファイルで期待される初期コードとフォーマットを提供します（業界または言語の標準、企業ポリシー、その他の理由による）。

AppCode は、新しいファイルを作成するときに提案される、サポートされているすべてのファイルタイプの定義済みテンプレートを提供します。

ファイルテンプレートの管理と構成

  • Ctrl+Alt+S を押して IDE 設定を開き、エディター | ファイルおよびコードテンプレートを選択します。

詳しくは、ファイルおよびコードテンプレートを参照してください。

デフォルトでは、テンプレートのリストには、AppCode によって提供される事前定義されたテンプレートのみが含まれています。それらのいくつかは内部的なものです。つまり、削除したり名前を変更したりすることはできません。AppCode は、内部テンプレートの名前を太字で示しています。変更したテンプレートの名前、および手動で作成したカスタムテンプレートは、青色で表示されます。

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

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

  1. Ctrl+Alt+S を押して IDE 設定を開き、エディター | ファイルおよびコードテンプレートを選択します。

  2. スキームリストを使用して、ファイルテンプレートを適用する範囲を選択します。

    • デフォルト : アプリケーション全体のファイルテンプレートを構成します。これらのテンプレートは、現在の IDE インスタンスで開くすべてのプロジェクトで使用できます。特定のプロジェクトに関係なく、好みの個人用テンプレートとして使用してください。AppCode は、グローバルテンプレートを fileTemplates の IDE 構成ディレクトリに格納します。

    • プロジェクト : 現在のプロジェクトに固有のファイルテンプレートを構成します。これらのテンプレートは、このプロジェクトに携わるすべての人が利用できます。AppCode は、.idea/fileTemplates のプロジェクトフォルダーに保存します。

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

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

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

  1. Ctrl+Alt+S を押して IDE 設定を開き、エディター | ファイルおよびコードテンプレートを選択します。

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

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

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

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

  2. メインメニューからファイル | ファイルをテンプレートとして保存を選択します。

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

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

構文

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

  • プレーンテキストはそのままレンダリングされます。

  • 値に置き換えられる変数。例: ${NAME} は、ファイルを追加するときにユーザーが指定した名前を挿入します。

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

$ または # の入力を開始して、使用可能な変数およびディレクティブの補完候補を確認します。

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

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

#parse("C File Header.h") #import "${HEADER_FILENAME}" @implementation ${NAME} #if ($PUT_IVARS_TO_IMPLEMENTATION == "true"){ } #end @end

このテンプレートは、次のように構成されています。

  • #parse 指示文は、C File Header.h テンプレートの内容を挿入するために使用されます。

  • #import ディレクティブは、ヘッダーファイルへのリンクを挿入するために使用されます。

  • 次に、テンプレートは、${NAME} 値（新しいファイルの名前）として渡された名前を持つクラスの実装を追加します。$PUT_IVARS_TO_IMPLEMENTATION は、インスタンス変数をクラス実装内に配置する必要があるかどうかを定義します。可能であれば、イバールを実装するチェックボックス（AppCode | 環境設定 | エディター | コードスタイル | C/C++/Objective-C）を使用して、このオプションの値を変更できます。値が true の場合、クラス名の後に波括弧が追加されます。

テンプレートに基づいて新しい Objective-C クラスを作成すると、次のような内容のファイルが生成されます。

// // Created by John Smith on 2019-07-01. // Copyright (c) 2019 JetBrains. All rights reserved. // #import "NewClass.h" @implementation NewClass { } @end

対応するヘッダーファイルが同時に作成されます。

言語インジェクション ファイルテンプレート変数

関連ページ：

ファイルおよびコードテンプレート

AppCode は、ファイルテンプレートで説明されているファイルテンプレートを使用してファイルを作成します。このページを使用して、そのようなテンプレートを表示、編集、作成します。スキームファイルテンプレートを適用するスコープを選択します。デフォルト: アプリケーション全体のファイルテンプレートを構成します。これらのテンプレートは、現在の IDE インスタンスで開くすべてのプロジェクトで使用できます。特定のプロジェクトに関係なく、好みの個人用テンプレートとして使用してください。AppCode は、...

コード補完

このセクションでは、コーディングプロセスのスピードアップを可能にするコンテキスト対応コード補完のさまざまなテクニックについて説明します。基本補完：基本コード補完は、可視性スコープ内のクラス、メソッド、キーワードの名前を補完するのに役立ちます。コード補完を呼び出すと、AppCode はコンテキストを分析し、現在のキャレット位置から到達可能な選択肢を提案します (提案にはライブテンプレートも含まれます)。基本補完を呼び出す名前の入力を開始します。デフォルトでは、AppCode は、入力時にコード補...

言語インジェクション

言語インジェクションを使用すると、コードに埋め込まれた他の言語のコードを操作できます。言語（HTML、CSS、XML、RegExp など）を文字列リテラルに挿入すると、そのリテラルを編集するための包括的なコード支援が得られます。一時的に言語をインジェクションするデフォルトでは、IDE は一時的に言語を挿入します。これは、埋め込まれた要素を削除すると、インジェクションも失われることを意味します。言語を挿入する文字列リテラル、タグ、属性内にキャレットを配置し、を押します（またはインテンションアクシ...