IntelliJ IDEA 2020.2ヘルプ

外部注釈

ソースコードに注釈を保存することは必ずしも便利ではありません。例:全員が異なるIDEを使用するチームでプロジェクトに取り組んでいる場合、ライブラリクラスを使用している場合、または注釈からコードを解放したい場合。これは、外部注釈を使用できる場合です。

External annotations are regular annotations that are stored outside your source code in an XML file called annotations.xml

コードでは、外部注釈は External annotation icon ガターアイコンでマークされ、グレーで強調表示されます。デフォルトでは、IntelliJ IDEAはエディターに外部注釈を表示します。

External annotations in the editor

外部注釈を有効にする

外部注釈を使用するには、設定でこのオプションを有効にする必要があります。このステップをスキップすると、ライブラリコードに外部から注釈を付けることはできますが、外部注釈をソースコードに使用することはできません。

  1. Ctrl+Alt+S を押して設定/環境設定ダイアログを開きます。

  2. エディター | コード・スタイル | Java | コード生成に移動し、外部の注釈を使用するチェックボックスを選択します。

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

注釈を外部にする

  • 通常の注釈を外部注釈にすばやく変換するには、その場所にキャレットを置いて Alt+Enter を押して(またはインテンションアクション Intention action icon アイコンをクリックして)、注釈を外部にを選択します。

    Converting a regular annotation to an external annotation

新しい注釈を追加する

  1. 注釈を付ける要素の Alt+Enter を押します(または、インテンションの Intention action icon アイコンをクリックします)。

  2. 注釈<要素> <要素名> (たとえば、Annotate field 'out')を選択して、注釈を選択します。

    Adding a new external annotation

    注釈が1つしかない場合は、<element> <element name>に@ <Annotation>注釈を付けます。オプション(たとえば、Annotate class 'String' as @Deprecated)を選択します。

  3. 次のダイアログで、外部から追加するをクリックします。

  4. 外部注釈(外部注釈ルート)を使用してファイルを格納するディレクトリを指定します。

    このモジュール内の次の外部注釈はすべて同じフォルダーに格納されます。複数の注釈ルートがある場合、IntelliJ IDEAは使用するものをあなたに確認します。

注釈のルートディレクトリを設定する

注釈ルートディレクトリは、プロジェクトの現在のモジュールで使用されている外部注釈を保存するフォルダーです。新しいルートを変更、削除、追加することができます:

  1. Ctrl+Alt+Shift+S を押してプロジェクト構造ダイアログを開きます。

  2. モジュール | パスに移動します。

  3. モジュールに接続された外部注釈を管理できる外部注釈領域を見つけます。

注釈はプロジェクトレベルでも設定できます。プロジェクト構造ダイアログで、SDK | 注釈をクリックします。

In case external annotations are added to the elements of the external library of a Maven/Gradle project, the path to the annotations root directory will be stored in プロジェクト構造 | モジュール | 依存関係 in the 注釈 list of the Maven/Gradle library.

外部注釈を非表示

外部注釈は、デフォルトでエディターに表示されます。コードから隠すことができます:

  1. Ctrl+Alt+S を押してエディター | 一般 | 外観を選択します。

  2. 外部の注釈をインラインで表示するチェックボックスをクリアします。

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

外部注釈が隠されている場合、ガター内の External annotation icon アイコンのみがコード内にその存在をマークします。

Mavenから外部注釈をダウンロードする

  • 外部の注釈をMavenの成果物として保管し、ライブラリと一緒にダウンロードすることができます。そうするには、Maven リポジトリからライブラリをダウンロードダイアログの注釈チェックボックスを選択します。

Downloading a library from Maven

IntelliJ IDEAは、annotations 分類子を使用してすべての成果物を検索し、それらがリポジトリで使用可能な場合はそれらをダウンロードします。

最終更新日: 2020年5月08日