HTML文の記述

Javadoc中に記述する文はHTML文として解釈されます。逆に言えばHTML文として記述する必要があります。例えば「<」は「&lt;」として記述する必要があります。

HTML文ですのでHTMLタグを使用することが可能です。

/**
 *  コメントは<b>HTML文</b>として記述する
 */

HTMLタグを使用できますがクラスやパッケージ以外の箇所で<h1>や<h2>などの見出しタグは使用しないほうがいいようです。

サンプル

では簡単な例で試してみます。

Sample02_01.java

/**
 * Javadoc<b>テスト</b>用クラス
 * <a href="https://www.javadrive.jp/">リンク</a>の記述
 */
public class Sample02_01{
  /**
   * <font color="#ff0000">サイズ</font>の設定
   * @param width 幅
   * @param height <font color="#0000ff">高さ</a>
   */
  public void setSize(int width, int height){

  }
}

では上記のソースコードを「Sample02_01.java」の名前で保存し、その保存したディレクトリで次のように実行して下さい。

javadoc -d doc Sample02_01.java

「doc」ディレクトリ内にある「Sample02_01.html」ファイルをブラウザで見てください。

今回は<b>タグによる強調や、<a>タグによるリンク、<font color="">による色の指定を試してみました。

サンプル

では今度はスタイルシートも試してみます。

Sample02_02.java

/**
 * Javadocテスト用クラス
 * <p style="color:#ff0000">スタイルシート</p>の記述
 */
public class Sample02_02{
  /**
   * サイズの設定
   * @param width 幅
   * @param height 高さ
   */
  public void setSize(int width, int height){

  }
}

では上記のソースコードを「Sample02_02.java」の名前で保存し、その保存したディレクトリで次のように実行して下さい。

javadoc -d doc Sample02_02.java

「doc」ディレクトリ内にある「Sample02_02.html」ファイルをブラウザで見てください。

上記のようにスタイルシートも記述した通りに反映されています。

著者 / TATSUO IKURA

これから IT 関連の知識を学ばれる方を対象に、色々な言語でのプログラミング方法や関連する技術、開発環境構築などに関する解説サイトを運営しています。