4.10. Java API ドキュメントのコードスニペット


Red Hat build of OpenJDK 21 には、Javadoc ツールの標準ドックレット用の @snippet タグが含まれています。@snippet タグは、API ドキュメントへのソースコードのサンプルの追加を簡素化するのに役立ちます。

以下に例を示します。

/**
 * The following code shows how to use {@code Optional.isPresent}:
 * {@snippet :
 * if (v.isPresent()) {
 * 	System.out.println("v: " + v.get()); // @highlight substring="println"
 * }
 * }
 */
Copy to Clipboard

マークアップタグ

@snippet タグを @highlight などのマークアップタグと組み合わせて使用して、コードのスタイルを変更できます。たとえば、次のコードスニペットでは、@highlight タグを使用して、API ドキュメント内の println メソッド名を強調表示します。

/**
 * The following code shows how to use {@code Optional.isPresent}:
 * {@snippet :
 * if (v.isPresent()) {
 * 	System.out.println("v: " + v.get()); // @highlight substring="println"
 * }
 * }
 */
Copy to Clipboard

外部ファイル

@snippet タグを、ソースコードを含む外部ファイルと組み合わせて使用することもできます。

以下に例を示します。

/**
 * The following code shows how to use {@code Optional.isPresent}:
 * {@snippet file="ShowOptional.java" region="example"}
 */
Copy to Clipboard

上記の例では、ShowOptional.java は次のコードを含むファイルです。

public class ShowOptional {
	void show(Optional<String> v) {
    	// @start region="example"
    	if (v.isPresent()) {
        	System.out.println("v: " + v.get());
    	}
    	// @end
	}
}
Copy to Clipboard

外部コードの場所は、class 属性を使用してクラス名として指定することも、file 属性を使用して相対ファイルパスとして指定することもできます。

詳細は、JEP 413: Code Snippets in Java API Documentation を参照してください。

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat