Javadocのメソッドパラメータへの参照を追加する

投稿日: 2022-11-09 2022-11-09
タグ: Java, javadoc

1. 概要

Java言語では、 Javadoc を使用して、JavaソースコードからHTML形式のドキュメントを生成できます。このチュートリアルでは、Javadocでメソッドパラメータへの参照を追加するさまざまな方法について学習します。

2. メソッドパラメータへの参照を追加するさまざまな方法

このセクションでは、Javadocのメソッドパラメータへの参照を追加する方法について説明します。インラインタグの使用法を確認します {@コード} およびHTMLスタイルタグ de> Javadocで。

さらに、その方法を見ていきます {@コード} とtag take care of a few special cases:

特殊文字'<‘、’>’、および’@’を表示する
インデントと改行
HTMLコードのエスケープの処理—たとえば、<はシンボル'<‘に変換されます

2.1. {@code}タグ

{@ code text} は、 JDK1.5に含まれていたインラインタグです。

{@ code} タグは、文字通りのテキストをコードフォントでフォーマットします。 {@ code abc} は、 {@literal abc}と同等です。

{@code}タグ内で使用されている特殊文字を手動でエスケープする必要はありません。

{@ code} タグを使用すると、次のようになります。

‘<‘および’>’を正しく表示します
‘@’を正しく表示します
HTML番号コードを介して特殊文字をエスケープする必要はありません
より読みやすく簡潔です

クラスに簡単なメソッドを作成し、 {@code}タグを使用してJavadocを追加しましょう。

/**
  * This method takes a {@code String} 
  * and searches in the given list {@code List<String>}
  * 
  * @param name
  *        Name of the person
  * @param avengers
  *        list of Avengers names
  * @return true if found, false otherwise
  */
public Boolean isAvenger(String name, List<String> avengers) {
    return avengers.contains(name);
}

ここでは、特殊文字「<」および「>」をエスケープする必要がないことがわかります。

生成されたJavadocは、HTML出力を次のようにレンダリングします。

同様に、「@」文字をエスケープする必要がないことがわかります。

/**
  * This is sample for showing @ use without any manual escape.
  * {@code @AnyAnnotaion}
  * 
  */
public void javadocTest() {
}

これにより、HTMLJavadocは次のようにレンダリングされます。

Javadocの複数行コードスニペットの場合、 {@code}はインデントと改行を維持しません。これを克服するために、HTMLタグを使用できます

一緒に {@コード} 。ただし、この場合は「@」文字をエスケープする必要があります。

2.2. The `Tag`

is an HTML style tag supported by Javadoc.

私たちが使用するときtag, it:

‘<‘および’>’が正しく表示されない
HTML番号コードを介して特殊文字をエスケープする必要があります
あまり読めない

同じ例をもう一度考えてみましょう。私たちはそれを見ることができます生成されたJavadocHTMLに段落のリストの後のパラメータ化されたタイプ ：

/**
  * This method takes a <code>String</code>
  * and searches in the given <code>List<String></code>
  * 
  * @param name
  *        Name of the person
  * @param avengers
  *        list of Avengers names
  * @return true if found, false otherwise
  */
public Boolean isAvenger(String name, List<String> avengers) {
    return avengers.contains(name);
}

ここで、メソッドコメントで特殊文字'<‘および’>’をエスケープすると、正しいレンダリングが行われます。 Javadocの場合：

/**
  * This method takes a <code>String</code>
  * and searches in the given <code>List<String></code>
  * 
  * @param name
  *        Name of the person
  * @param avengers
  *        list of Avengers names
  * @return true if found, false otherwise
  */
public Boolean isAvenger(String name, List<String> avengers) {
    return avengers.contains(name);
}

3. 結論

このチュートリアルでは、最初に使用方法について説明しました {@コード} とto reference method parameters in Javadoc. 次に、これらのタグによる特殊文字の処理について説明しました。結論として、Javadocでメソッドパラメータへの参照を追加する方法を理解しました。 {@code}の方が優れていることがわかりますany day.

getdocs

13036