Geekroid-ギークロイド(仮)|ITエンジニアの日常をささいな情報で彩るコラム

ITエンジニアの転職

javadocコマンド

APIドキュメントを作成する – javadocコマンド
javadoc option src
option:コマンドオプション
src:ドキュメントのもととなるソースファイル

javadocコマンドは、ソースファイルに記述されたドキュメンテーションコメントからAPIドキュメントを作成します。公式サイトで公開されているAPIドキュメントも、もともとはjavadocコマンドで作成されたものです。 たとえば以下は、Java標準ライブラリに含まれるMathクラスにおけるドキュメンテーションコメントの例です。

/**
 * The class {@code Math} contains methods for performing basic
 * numeric operations such as the elementary exponential, logarithm,
 * square root, and trigonometric functions.
 * ...中略...
 * @author  unascribed
 * @author  Joseph D. Darcy	… 作者
 * @since   JDK1.0	… 対応バージョン
 */
public final class Math {
  ...中略...
  /**
   * Returns the trigonometric sine of an angle.  Special cases:
   * 
  • If the argument is NaN or an infinity, then the * result is NaN. … メソッドの概要 ...中略... * @param a an angle, in radians. … 引数 * @return the sine of the argument. … 戻り値 */ public static double sin(double a) { return StrictMath.sin(a); // default impl. delegates to StrictMath } ...中略... }

javadocコマンドは、以下のように実行できます。以下は、/langフォルダーの.javaファイルをもとにドキュメントを作成する例です。出力先は/docsフォルダーです。

> javadoc -d docs C:_datalang*.java

javadocコマンドで利用できるオプション(option)には、以下のようなものがあります。

javadocコマンドで利用できる主なオプション
オプション 概要
-d パス 生成されたドキュメントを保存するフォルダー
-classpath パス 関連するクラスファイルの検索先。複数指定時は、セミコロン(Windows)、またはコロン(Unix)区切り
-private privateメソッドも含めて表示
-encoding 文字コード ソースファイルの文字コード
-docencoding 文字コード 生成されるドキュメントの文字コード
コマンド
javacコマンド
javaコマンド
jarコマンド
javadocコマンド

Geekroid-ギークロイド(仮)|ITエンジニアの日常をささいな情報で彩るコラム

ITエンジニアの転職