2002-03-17 初心者入門Javadocの記述 Home Javaのアプリケーションを作成する時に、メンテナンスなどを考えて各プログラムの仕様書を作成しなければいけない場合があります。ソースコードに含まれるクラスや、クラスに含まれるメソッドなどを後から調べて仕様書を作成するのは大変です。 JavadocはJDKに標準で含まれているプログラムで、ソースコードに含まれるクラスやメソッドのコメントから自動で仕様書を作成してくれる便利なツールです。ここではJavadocの記述方法を中心に使い方を確認していきます。 Javadocに準拠したコメントの記述方法を学習することで、Javaのプログラミングにおけるコメントの記述方法の標準を学習することもできます。 Javdocの基本 Javadocで生成されるドキュメント Javadocの対象となるコメントの記述方法 ドキュメントの作成 コメントの書式 コメントの構成 HTML文の記述 複数フィールドに対するコメントの記述の注意 Javadocタグ @authorタグ @versionタグ @seeタグ (テキスト、外部リンク) (残りの記事一覧へ ...) オプションの指定 「-help」オプション 「-d」オプション 「-author」オプション (残りの記事一覧へ ...)