IntelliJ IDEA 2024.1 ヘルプ

組み込みの IDE マクロ

IntelliJ IDEA は、外部ツール実行構成のさまざまなパス、オプション、その他のコマンドライン引数を指定するために使用できる変数である、多数の組み込みマクロを提供します。値としてマクロを受け入れるダイアログフィールドには、プラスアイコン が表示されます。

Add an IDE macro

マクロの値は現在のコンテキストによって異なります。例: 現在のファイルを含むディレクトリの名前を渡す必要がある場合は、$FileDirName$ を使用できます。または、フルパスが必要な場合: $FileDir$

マクロ

説明

$WORKSPACE_DIR$

現在のプロジェクトが属するワークスペースへのパス。ワークスペースは、開いているファイル階層のルートであり、複数のプロジェクトを含めることができます。

$PROJECT_DIR$

run.json が配置されているプロジェクトのルート。プロジェクトは通常、Maven プロジェクトや Node.js プロジェクトなどのアプリケーションを開発および構築するためのファイルのコレクションです。

$USER_HOME$

ユーザーのホームディレクトリ。

$FILE$

現在のファイルへの絶対パス (拡張子を含む)。

$AffectedModuleNames$

現在のファイルに関連するモジュールの名前。コンマで区切られます。

$Classpath$

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

$ClasspathEntry$

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

$ClipboardContent$

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

$ColumnNumber$

現在のファイルでキャレットが配置されている列番号。

$ContentRoot$

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

$FileClass$

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

$FileDir$

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

$FileDirName$

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

$FileDirPathFromParent(dir)$

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

$FileDirRelativeToProjectRoot$

モジュールのコンテンツルートに関連する現在のファイルを含むディレクトリへのパス。

$FileDirRelativeToSourcepath$

ソースパスルートを基準にした現在のファイルを含むディレクトリへのパス。

$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$

モジュールのコンテンツルートに関連する現在のファイルへのパス。

$FilePathRelativeToSourcepath$

ソースパスルートを基準にした現在のファイルへのパス。

$FilePrompt$

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

$FileRelativeDir$

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

$FileRelativePath$

モジュールのコンテンツルートに関連する現在のファイルへのパス。

$IsMake$

コンパイルが make で実行された場合、true を返します。

$JavaDocPath$

JavaDoc 出力ディレクトリ。

$JDKPath$

プロジェクトの JDK へのパス。

$LineNumber$

現在のファイルでキャレットが配置されている行番号。

$ModuleFileDir$

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

$ModuleFilePath$

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

$ModuleName$

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

$ModuleSdkPath$

現在のモジュールの JDK へのパス。

$ModuleSourcePath$

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

$OSName$

小文字のオペレーティングシステム名。

最初のスペース文字まで切り詰められた System.getProperty("os.name") の値を返します。特定のバージョンは含まれず、windowsmaclinux などの OS ファミリのみが含まれます。

$OutputPath$

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

$Password$

パスワードを指定するためのダイアログを表示します。$Prompt$ と似ていますが、入力はマスクされます。

オプションでコロンの後に追加してプロンプトテキストを指定することもできます。例:: $Password:API token$

$ProjectFileDir$

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

$ProjectName$

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

$Projectpath$

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

$Prompt$

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

オプションでプロンプトテキストとデフォルト値をコロンで区切って指定することもできます。例:: $Prompt:Username:Alice$

$RemoteProjectFileDir$

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

$SelectedText$

エディターで現在選択されているテキスト。

$SelectionEndColumn$

選択が終了する列番号。

$SelectionEndLine$

選択が終了する行番号。

$SelectionStartColumn$

選択が開始される列番号。

$SelectionStartLine$

選択が開始される行番号。

$Sourcepath$

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

$SourcepathEntry$

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

$TempDir$

一時ファイルのディレクトリ。

Windows では、%TEMP% 環境変数の値を返すか、ユーザーのホームディレクトリ内の AppData\Local\Temp ( System.getProperty("user.home") によって返される) にフォールバックします。

他のオペレーティングシステムでは、$TempDir$/tmp を返します。

$UnixSeparators(path)$

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

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

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

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

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

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

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

カスタムマクロ

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

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

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

関連ページ:

外部ツール

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

実行 / デバッグ構成

IntelliJ IDEA は、実行 / デバッグ構成を使用して、コードを実行、デバッグ、テストします。各構成は、何を実行し、どのパラメーターと環境を使用するかを定義する、名前付きのスタートアッププロパティのセットです。実行 / デバッグ構成には 2 つのタイプがあります。一時的 — 永続的な構成を持たないクラスを実行するたびに作成されます。これは、メソッドを持つクラスの実行を可能にする最低限のものを提供します。永続的 — テンプレートから明示的に作成されるか、一時的な構成を保存することによって作成...

モジュール

IntelliJ IDEA では、モジュールはプロジェクトの重要な部分であり、プロジェクトと一緒に自動的に作成されます。プロジェクトには複数のモジュールを含めることができます。新しいモジュールを追加し、グループ化し、現時点では必要のないモジュールをアンロードできます。通常、モジュールは 1 つまたは複数のコンテンツルートとモジュールファイルで構成されますが、モジュールはコンテンツルートがなくても存在できます。コンテンツルートは、コードを保存するフォルダーです。通常、ソースコード、単体テスト、リソ...

コンテンツルート

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

エンコード

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

SDK

ソフトウェア開発キットまたは SDK は、特定のソフトウェアフレームワーク用のアプリケーションを開発するために必要なツールのコレクションです。例: Java でアプリケーションを開発するには、Java SDK(JDK) が必要です。SDK には、バイナリ、バイナリのソースコード、ソースコードのドキュメントが含まれています。JDK ビルドにはアノテーションも含まれています。一般に、SDK はグローバルです。つまり、1 つの SDK を複数のプロジェクトやモジュールで使用できます。新しいプロジェクトを作...