AppCode 2023.1 ヘルプ

組み込みの IDE マクロ

AppCode は、多数の組み込みマクロを提供します。これらのマクロは、外部ツールおよび実行構成のさまざまなパス、オプション、その他のコマンドライン引数を指定するために使用できる変数です。それらの値は、現在のコンテキストによって異なります。例: 現在のファイルを含むディレクトリの名前を渡す必要がある場合は、$FileDirName$ を使用できます。または、フルパスが必要な場合: $FileDir$

マクロ

説明

$Classpath$

プロジェクトの完全なクラスパス。

$ClasspathEntry$

現在のファイルに関連するクラスパスのエントリ。

$ClipboardContent$

システムクリップボードの現在の内容。

$ContentRoot$

現在のファイルが属するコンテンツルートへのパス。

$FileClass$

現在のファイルで定義されているクラスの名前。

$FileDir$

現在のファイルを含むディレクトリへの絶対パス。

$FileDirName$

現在のファイルを含むディレクトリの名前。

$FileDirPathFromParent(dir)$

パラメーター dir として指定された親ディレクトリを基準にした現在のファイルを含むディレクトリへのパス。

$FileDirRelativeToProjectRoot$

モジュールのコンテンツルートに相対的な現在のファイルを含むディレクトリへのパス。

$FileEncoding$

現在のファイルのエンコーディング

$FileExt$

現在のファイルの拡張子。

$FileFQPackage$

現在のファイルの完全修飾パッケージ名。

例: com.example.mypackage.MyClass の場合、パッケージの完全修飾名は com.example.mypackage です。

$FileName$

現在のファイルの名前(すべての拡張子を含む)。

$FileNameWithoutAllExtensions$

拡張子のない現在のファイルの名前。これは、ファイルの拡張子が重複している場合に役立ちます。ピリオドとそれに続くすべてのものが削除されます。

例: ファイルが hello.txt.txt の場合、$FileNameWithoutAllExtensions$ マクロは hello を返します。

$FileNameWithoutExtension$

拡張子のないファイルの名前。これにより、ピリオドの 1 回だけが削除され、その後に延長が続きます。

例: ファイルが hello.txt.txt の場合、$FileNameWithoutExtension$ マクロは hello.txt を返します。

$FilePackage$

現在のファイルの即時パッケージ名(完全修飾ではありません)。

例: com.example.mypackage.MyClass の場合、パッケージの名前は mypackage です。

$FileParentDir$

現在のファイルが置かれているディレクトリへの親ディレクトリの名前。

$FilePath$

現在のファイルへの絶対パス。

$FilePathRelativeToProjectRoot$

モジュールのコンテンツルートに相対的な現在のファイルへのパス。

$FilePrompt$

ファイルを選択するためのファイルシステムダイアログを表示します。

$FileRelativeDir$

モジュールのコンテンツルートを基準とした、現在のファイルが配置されているディレクトリへのパス。

$FileRelativePath$

モジュールのコンテンツルートに相対的な現在のファイルへのパス。

$JavaDocPath$

JavaDoc 出力ディレクトリ。

$ModuleFileDir$

現在のモジュールファイルが配置されているディレクトリへの絶対パス。

$ModuleFilePath$

現在のモジュールファイルへの絶対パス。

$ModuleName$

拡張子のない現在のモジュールファイルの名前。

$ModuleSourcePath$

現在のモジュールのソースパス。

$OutputPath$

現在のモジュールの出力パス。

$ProjectFileDir$

現在のプロジェクトディレクトリへの絶対パス。

$ProjectName$

現在のプロジェクトディレクトリの名前。

$Projectpath$

現在のプロジェクトのソースパス。

$Prompt$

任意の文字列を渡すためのダイアログを表示します。

$RemoteProjectFileDir$

リモートサーバー上のプロジェクトディレクトリへの絶対パス。

$UnixSeparators(path)$

パラメーターとしてパスを取り、すべての区切り文字をスラッシュに変換します。

例: $UnixSeparators(\foo\bar)$/foo/bar を返します。

プロジェクト外のリソースへのパス

パス変数を使用して、プロジェクト外のリソースを指すことができます。マクロを追加するのと同じ方法で、変数の前後にアンパサンドを付けて、構成済みのパス変数を追加します: $MY_VAR$

新しいパス変数を作成する

  1. Ctrl+Alt+S を押して IDE 設定を開き、外観 & 振る舞い | パス変数を選択します。

  2. the Add button をクリックし、変数の名前と値を入力し、OK をクリックして変更を適用します。

カスタムマクロ

com.intellij.ide.macro.Macro 拡張ポイントを使用して、プラグインのカスタムマクロを定義できます。その後、マクロを plugin.xml に登録します。

<macro implementation="full.macro.class.Name"/>

使用可能な拡張ポイントの詳細については、IntelliJ プラットフォームプラグイン SDK ドキュメント(英語)を参照してください。

関連ページ:

外部ツール

サードパーティのコマンドラインアプリケーションを外部ツールとして構成して、AppCode から実行します。例: ワークフローでは、特定のスクリプト、コードジェネレーター、アナライザー、プリプロセッサーまたはポストプロセッサー、データベースユーティリティなどの実行が必要になる場合があります。外部ツールとして構成することにより、AppCode は専用のアクションを提供します。これは、メインメニューや特定のコンテキストメニューから実行したり、ショートカットを割り当てたり、特定の実行構成を起動するときに...

実行 / デバッグ構成

AppCode は、実行 / デバッグ構成を使用して、コードを実行、デバッグ、テストします。各構成は、何を実行し、どのパラメーターと環境を使用するかを定義する、名前付きのスタートアッププロパティのセットです。AppCode の実行 / デバッグ構成は Xcode スキームと同等であり、それらとの同期が維持されます。実行 / デバッグ構成には 2 つのタイプがあります。一時的 — テストクラスまたはメソッドを実行するたびに作成され、ガターアイコン / を使用します。永続的 — テンプレートから明示的に作成さ...

エンコード

ファイルを正しく表示および編集するには、AppCode は使用するエンコーディングを認識する必要があります。一般に、ソースコードファイルはほとんど UTF-8 です。他の要件がない限り、これが推奨されるエンコーディングです。ファイルのエンコーディングを決定するために、AppCode は次の手順を使用します。バイトオーダーマーク(BOM)が存在する場合、AppCode は、他のすべての設定に関係なく、対応する Unicode エンコーディングを使用します。詳細については、バイト順マークを参照してく...

パス変数

パス変数は、プロジェクトにリンクされたリソースへのパスを表すプレースホルダーです。コンピューター上の固定された場所を参照する必要がないため、共有の柔軟性が提供されます。パス変数は、たとえば、プロジェクトまたはモジュールレベルで定義されたサードパーティライブラリがあり、プロジェクトディレクトリまたはモジュールコンテンツルート(VCS を介して共有されるプロジェクト用)の外部に保存されている場合に役立ちます。このようなライブラリはその絶対パスによって参照され、このパスがチームメイトのコンピューター上...

アイコン参照

AppCode の多くのエンティティはアイコンでマークされています。ツールバーボタン、ガター、プロジェクトツールウィンドウなどにアイコンがあります。アイコンの大部分には、その意味をすばやく把握できるツールチップがあります。アイコンの上にマウスを置くと、ツールチップに簡単な情報が表示されるのを待ちます。ガターアイコン:ガターアイコンは左側のエディターにあります。ガター内のすべてのアイコンには、その意味を説明するツールチップがあります。使用可能なガターアイコンのリストは、プロジェクトの構成、使用す...