IntelliJ IDEA 2024.1 ヘルプ

Javadoc

Javadoc コメントは通常、ソースコード内のクラス、メソッド、フィールドの上に配置されます。Javadoc は、その下にあるコード要素の説明を提供し、特定のメタデータを含む @ でマークされたブロックタグを含みます。

JDK に付属の Javadoc ツールを使用して、プロジェクトの API リファレンスを HTML で生成できます。IntelliJ IDEA はツールとの統合を提供し、IDE から直接リファレンスガイドを構築できるようにします。

Javadoc の正しい形式、スタイルガイド、用語と規則について詳しくは、Javadoc ツールのドキュメントコメントの書き方(英語)を参照してください。

Javadoc の追加

自動コメントを使用して Javadoc を追加する

ドキュメントのコメントについては、IntelliJ IDEA はデフォルトで有効になっている補完機能を提供します。

  • 宣言の前に /** と入力し、Enter を押します。IDE は、ドキュメントコメントを自動的に補完します。

Javadoc コメントの自動挿入を無効にできます。設定ダイアログ Ctrl+Alt+S で、エディター | 一般 | スマートキーに移動し、ドキュメントコメントスタブを挿入するチェックボックスをオフにします。

コンテキストアクションを使用して Javadoc を追加する

  • エディターの宣言にキャレットを置き、Alt+Enter を押して、リストから Javadoc の追加を選択します。

    Adding a Javadoc using the 'Add Javadoc' context action

Kotlin では、推奨されるスタイル(英語)ではパラメーターの説明と戻り値をドキュメントコメントに直接組み込む必要があるため、@param およびその他のタグは生成されません。

Javadoc の修正

メソッドシグネチャーが変更されている場合、IntelliJ IDEA はメソッドシグネチャーと一致しないタグをハイライトし、クイックフィックスを提案します。

コンテキストアクションを使用して修正する

  • タグにキャレットを置き、Alt+Enter を押して、アクションを選択します。タグの変更や削除も可能です。

    Fix a Javadoc using context actions

「ドキュメントコメントを修正」アクションを使用して修正する

ドキュメントコメントアクションを修正を使用して、宣言の変更を考慮して既存の Javadoc コメントを更新することもできます。

  1. クラス、メソッド、関数、フィールドにキャレットを置き、Ctrl+Shift+A を押します。

  2. fix doc comment と入力し、Enter を押します。

Javadoc をレンダリングする

IntelliJ IDEA を使用すると、エディターで Javadoc をレンダリングできます。レンダリングされたコメントは読みやすく、余分なタグでコードに負荷をかけることはありません。

必要なドキュメントコメントの横のガターで the Toggle Rendered View icon をクリックして（または Ctrl+Alt+Q を押して）、レンダリングビューを切り替えます。the Toggle Rendered View icon をクリックしてコメントを編集します。

Javadocs in the editing mode
Javadocs in the rendered mode

レンダリングされた Javadoc を使用すると、リンクをクリックして参照先の Web ページに移動したり、参照先のトピックのクイックドキュメントを表示したりできます。

フォントサイズを変更するには、エディターで Javadoc を右クリックし、コンテキストメニューからフォントサイズの調整を選択します。レンダリングされたコメントは、クイックドキュメントポップアップと同じフォントサイズを使用することに注意してください。

デフォルトで Javadoc をレンダリングする

エディターで常に Javadoc をレンダリングするように IDE を構成できます。

  • (ガターの the Toggle Rendered View icon アイコンまたは the Toggle Rendered View icon) を右クリックし、すべてレンダリングオプションを有効にします。

    または、設定ダイアログ Ctrl+Alt+S でエディター | 一般 | 外観を選択し、ドキュメントコメントをレンダリングするオプションを有効にします。

レンダリングされた Javadoc を編集するには、コメントの横のガターにある the Toggle Rendered View icon アイコンをクリックします。

Javadoc でカスタムタグを使用する

Javadocs コメントでは、事前定義されたタグの上にカスタムタグを使用できます。後で、 API リファレンスガイドに含めることができます。

カスタムタグを認識する

カスタムタグを初めて使用すると、Javadoc 宣言の問題インスペクションはそのタグを間違ったタグとしてエディターでハイライトします。これを回避するには、認識されるタグのリストにタグを追加します。

  • カスタムタグにキャレットを置き、Alt+Enter を押して、カスタムタグに「@tagname」を追加を選択します。

    Recognize custom tags using context action

  • または、Ctrl+Alt+S を押して IDE 設定を開き、エディター | インスペクションを選択します。リスト内で Javadoc 宣言の問題インスペクションを見つけて、タグを追加の JavaDoc タグリストに追加します。

    Recognize custom tags in settings

Javadoc リファレンスにカスタムタグを含める

カスタムタグを HTML Javadoc 参照に含めるには、コマンドライン引数として追加します。

  1. ツール | JavaDoc の生成に移動し、コマンドライン引数フィールドに -tag tagname:Xaoptcmf:"taghead" を指定します。

    サンプル: -tag location:a:"Development Location:"

    Xaoptcmf は、ソースコード内のどこにタグを配置できるかを決定します。a を使用すると、すべての場所でタグを許可できます。Javadoc のブロックタグの詳細については、Oracle のドキュメント(英語)を参照してください。

  2. Javadoc リファレンスを生成するの説明に従って他のオプションを設定し、リファレンスガイドを生成します。

    タグからの情報は、対応するページに表示されます。

    Custom tag generated

Javadoc リファレンスを生成する

IntelliJ IDEA には、プロジェクトの Javadoc リファレンスを生成するためのユーティリティが用意されています。

  1. メインメニューで、ツール | JavaDoc の生成に移動します。

  2. 開いたダイアログで、スコープ、つまり参照を生成するファイルまたはディレクトリのセットを選択します。

  3. 出力ディレクトリで、生成されたドキュメントを配置するフォルダーを指定します。

  4. 可視性レベルリストから、生成されたドキュメントに含まれるメンバーの可視性レベルを選択します。

    • Private: すべてのクラスとメンバーが含まれます。このレベルは、-private Javadoc パラメーターに対応します。

    • パッケージ : プライベートなものを除くすべてのクラスとメンバーが含まれます。このレベルは、-package Javadoc パラメーターに対応します。

    • Protected: パブリックおよび保護されたクラスとメンバーのみが含まれます。このレベルは、-protected Javadoc パラメーターに対応します。

    • Public: パブリッククラスとメンバーのみが含まれます。このレベルは、-public Javadoc パラメーターに対応します。

  5. ロケール（たとえば en_US.UTF-8）、コマンドライン引数、最大ヒープサイズを指定できます。

  6. 生成をクリックして参照を生成します。

Javadoc の生成スコープの指定ダイアログ

ツール | JavaDoc の生成ダイアログは、Javadoc(英語) ユーティリティを呼び出します。ダイアログのコントロールは、このユーティリティのオプションとタグに対応しています。

項目

説明

JavaDoc のスコープ

この領域を使用して、Javadoc を生成するファイル、フォルダー、パッケージのサブセットを指定します。

このスコープは、プロジェクト全体、最近変更されたファイル、現在のファイル、カスタムスコープなどにすることができます。

テストソースを含める

生成された Javadoc にテスト用のドキュメントコメントを含めます。

-sourcepath に JDK およびライブラリのソースを含める

このチェックボックスを選択すると、JDK およびライブラリソースへのパスが Javadoc ユーティリティに渡されます。詳細については、ドキュメント(英語)を参照してください。

JDK ドキュメントへのリンク（-link オプションを使用）

このチェックボックスが選択されている場合、JDK からのクラスおよびパッケージへの参照はリンクに変わります。これは、Javadoc ユーティリティの -link(英語) オプションの使用に対応します。

このチェックボックスは、オンラインドキュメントへのリンクが SDK 設定のドキュメントパスタブで指定されている場合にのみ有効です。

詳細については、Javadoc(英語) のドキュメントを参照してください。

出力ディレクトリ

生成されたドキュメントが保存されるディレクトリへの完全修飾パスを指定します。パスを手動で入力するか、the Browse button をクリックしてダイアログで場所を選択します。指定された値は、Javadoc ユーティリティの -d パラメーターに渡されます。指定したディレクトリがシステムに存在しない場合は、ディレクトリを作成するように求められます。

可視性レベル

生成されたドキュメントに含めるメンバーの可視性レベルを指定します。

  • Private: すべてのクラスとメンバーが含まれます。このレベルは、-private Javadoc パラメーターに対応します。

  • パッケージ : プライベートなものを除くすべてのクラスとメンバーが含まれます。このレベルは、-package Javadoc パラメーターに対応します。

  • Protected: パブリックおよび保護されたクラスとメンバーのみが含まれます。このレベルは、-protected Javadoc パラメーターに対応します。

  • Public: パブリッククラスとメンバーのみが含まれます。このレベルは、-public Javadoc パラメーターに対応します。

階層ツリーを生成する

クラス階層を生成します。このチェックボックスをオフにすると、-notree パラメーターが Javadoc に渡されます。

ナビゲーターバーの生成

ナビゲーターバーを生成します。このチェックボックスをオフにすると、-nonavbar パラメーターが Javadoc に渡されます。

インデックスを生成する

ドキュメントのインデックスを生成します。このチェックボックスをオフにすると、-noindex パラメーターが Javadoc に渡されます。

インデックスを頭文字で分ける

文字ごとに個別のインデックスファイルを生成します。このチェックボックスをオフにすると、-splitindex パラメーターが Javadoc に渡されます。

このチェックボックスは、インデックスを生成するチェックボックスが選択されている場合にのみ使用できます。

@use

クラスとパッケージの使用箇所を文書化します。選択すると、チェックボックスは -use Javadoc パラメーターに対応します。

@author

@author の段落を含めます。選択すると、チェックボックスは -author Javadoc パラメーターに対応します。

@version

@version の段落を含めます。選択すると、チェックボックスは -version Javadoc パラメーターに対応します。

@deprecated

@deprecated 情報を含めます。チェックボックスをオフにすると、-nodeprecated パラメーターが Javadoc に渡されます。

非推奨リスト

非推奨リストを生成します。チェックボックスをオフにすると、-nodeprecatedlist パラメーターが Javadoc に渡されます。

このチェックボックスは、@deprecated チェックボックスが選択されている場合にのみ使用できます。

ロケール

目的のロケールを入力します。

コマンドライン引数

Javadoc に渡す追加の引数を入力します。コマンドライン構文を使用します。

最大ヒープサイズ

Javadoc を実行するために Java VM が使用する最大ヒープサイズを MB 単位で入力します。

生成したドキュメントをブラウザーで開く

生成された Javadoc をブラウザーで自動的に開きます。

トラブルシューティング

javadoc: error – Malformed locale name: en_US.UTF-8

ロケールフィールドをクリアします。その他のコマンドライン引数フィールドに -encoding utf8 -docencoding utf8 -charset utf8 を追加します。

-encoding は、ソースファイルのエンコーディングを指定します。-docencoding は出力 HTML ファイルのエンコーディングを指定し、-charset は出力ファイルの HTML ヘッドセクションで指定された文字セットです。

リファレンス: Javadoc コードスタイル

Javadoc のコードスタイルを設定できます。Ctrl+Alt+S を押して設定を開き、エディター | コードスタイル | Java | Javadoc を選択します。必要に応じてオプションを設定し、ダイアログの右側の部分を使用して変更をプレビューします。

コードの整形からコードを再フォーマットする方法を学びます。

項目

説明

位置合わせ

この領域で、Javadoc コメントを整列させる方法を定義します。

  • パラメーター説明の位置を合わせる : このチェックボックスを選択すると、パラメーターの説明が最も長いパラメーター名に揃えられます。それ以外の場合は、記述は対応するパラメーター名と単一のスペースで区切られます。

  • 例外の説明の位置を合わせる : このチェックボックスを選択すると、スローされた例外の説明が最長の例外名に揃えられます。それ以外の場合、記述は例外名と単一のスペースで区切られます。

空白行

この領域で、Javadoc コメントの空白行を挿入する場所を定義します。

  • 説明の後 : このチェックボックスを選択すると、Javadoc コメントの説明セクションの後に空白行が自動的に挿入されます。

  • パラメーター説明の後 : このチェックボックスを選択すると、@param タグのグループの後に空白行が挿入されます。

  • return タグの後 : このチェックボックスを選択すると、@return タグの後に空白行が挿入されます。

無効なタグ

この領域では、無効なタグを保存するかどうかを定義します。

  • 無効なタグを維持する : このチェックボックスを選択すると、@invalidTag が保存されます。

  • 空の @param タグを維持する : 説明なしで @param タグを保持するには、このチェックボックスを選択します。

  • 空の @return タグを維持する : 説明なしで @return タグを保持するには、このチェックボックスを選択します。

  • 空の @throws タグを維持する : 説明なしで @throws タグを保持するには、このチェックボックスを選択します。

その他

この領域で、Javadoc コメントの追加のフォーマットオプションを指定します。

  • 行頭のアスタリスク (*) を許可する : Javadoc コメントの各行をアスタリスクで始めます。

  • @exception の代わりに @throws を使用する : @throws タグを使用します。

  • 右マージンで折り返す : 右マージンを超えるテキストを次の行に折り返します。

  • 空白行に "<p>" を生成する : 空の行に </p> タグを自動的に挿入します。

  • 空白行を維持する : 空の行を手動で追加するには、このチェックボックスを選択します。

  • 1 行のコメントは折り返さない : 開始タグと終了タグを使用して、1 行に短いコメントを付けます。

  • 改行を保持する : このチェックボックスが選択されていない場合（デフォルト）、ラインフィードは再フォーマット時に保持されません。これは、コメントを段落の境界内でフォーマットして、最小限のスペースを占める必要がある場合に便利です。

    このチェックボックスをオンにすると、改行は保存されます。

  • パラメーターの説明の前に改行する : Javadoc パラメーターの説明（ある場合）を新しい行に配置します。継続インデント値に基づいてインデントを使用します。

  • 継続行をインデントする : 複数行コメントの後続の行をインデントします。

生産性のヒント

エディターで Javadoc を表示する

IntelliJ IDEA では、任意のシンボルまたはメソッドシグネチャーの外部 Javadoc をエディターから直接表示できます。これを行うには、ライブラリドキュメントパスを構成するか、ダウンロードしたドキュメントを IDE に追加します。

  • エディターで必要なシンボルの上にマウスを置きます。

  • キャレットをシンボルに置き、Ctrl+Q （表示 | クイックドキュメント）を押します。

    Ctrl+Q をもう一度押して、ドキュメントツールウィンドウでこのドキュメントを開きます。

クイックドキュメントの詳細情報

コンストラクターをファクトリメソッドに置換 コードリファレンス情報

関連ページ：

Jsdoc コメント

IntelliJ IDEA は Jsdoc コメントを認識し、開始ブロックコメントを入力してを押すと、、やその他のタグを自動的に挿入することで作成できます。JSDoc コメントは、JavaScript および TypeScript でのを使用したドキュメント検索に使用されます。JavaScript ドキュメントの検索および TypeScript ドキュメントのルックアップを参照してください。また、連鎖メソッドでの型アノテーションおよびメソッド戻り型ヒントにも使用されます。IntelliJ IDE...

ドキュメントコメントを作成する

Python 関数のドキュメントコメントの作成：Python 関数のドキュメントコメントを作成するには文書化する関数の宣言の後にキャレットを置きます。三重引用符を開いて入力し、またはを押します。パラメーターと戻り値の意味のある説明を追加します。インテンションアクションを使用して Python 関数のドキュメントコメントを作成するにはキャレットを、文書化したい関数のどこかに置きます。を押して、利用可能なインテンションの動作を表示します。ドキュメント文字列スタブを挿入するを選択:PyCharm...

コードのドキュメント化

YARD および RDoc は、コードをドキュメント化するために複数のライブラリで使用される最も一般的なドキュメント生成ツールです。RubyMine では、クイックドキュメントルックアップを使用して、YARD または RDoc 構文で記述されたドキュメントを表示できます。さらに、RubyMine は、YARD タグで動作する拡張機能を提供します。欠落している YARD タグを作成する、YARD タグの有効性を確認して修正する、YARD タグを活用して、コードインサイトを向上させる (たとえば、オブジェ...

PHPDoc コメント

ドキュメントコメントの場合、PhpStorm はデフォルトで有効になっている補完を提供します。PhpStorm は、の開始タグを入力してを押すか、を押して、コード構造（クラス、メソッド、関数など）をドキュメント化するときに、PHPDoc ブロックのスタブを作成します。選択に応じて、PhpStorm は必要なタグを作成するか、空のドキュメントスタブを追加します。追加の PHP 固有のタグが必要な場合、PhpStorm は現在のコンテキストに関連するタグ名を提案するコード補完を提供します。特定の...

コードリファレンス情報

パラメーター情報：パラメーター情報ポップアップには、メソッド呼び出しと関数呼び出しのパラメーターの名前が表示されます。IntelliJ IDEA は、エディターで左括弧を入力するか、候補リストからメソッドを選択すると、1 秒 (1000 ミリ秒) 以内に、使用可能なすべてのメソッドシグネチャーを含むポップアップを自動的に表示します。ポップアップが閉じている場合、または IDE がポップアップを自動的に表示しないように構成されている場合は、ポップアップを明示的に呼び出すことができます。これを行う...

スコープとファイルの色

スコープは、プロジェクト内のファイル、パッケージ、フォルダーのグループです。スコープを使用して、さまざまな IDE ビューのプロジェクトアイテムを視覚的に区別し、特定の操作の範囲を制限できます。スコープは、プロジェクト内のファイルを論理的に編成するように設計されています。テストソースはテスト関連のスコープに移動でき、製品コードは製品ファイルのスコープに関連付けることができます。これらの論理チャンクにより、プロジェクトの管理が容易になります。例: テスト関連のインスペクションをテストクラスでのみ実...