ITエンジニアのプレイングマネージャー化応援サイト

Javadocの作り方

1.Javadocとは

Javadocとは、JavaのソースコードからHTML形式のAPI仕様書を生成するものです。
Javadocは以下のようなJavaクラスの仕様書の標準の書式です。

例えば、皆さんおなじみのJavaのAPIもJavadocで書かれています。
Javaの技術者の共通理解がありますので、この形式でドキュメントを残すと非常にわかりやすいです。

 

2.Javadocの作り方

Javadoc用のコメントは、以下のように書きます。

「@」を使い、以下のような特殊な意味を持たせることが可能です。

@author:作成者
@version:バージョン指定
@param:パラメータに関する説明
@return:戻り値に関する説明
@throws(@exception):発生する可能性のある例外に関する説明
@deprecated:クラスやメソッドなどを「非推奨」として指定

 

3.Javadocを生成するJavaのソースコードの例

 

NetBeansを使いJavadocを生成するには、プロジェクト・エクスプローラーでプロジェクトを右クリックして、javadocの生成を選択するだけです。

Javadocを見るには、ソースコードの中でパッケージ名やクラス名、メソッド名を選択した状態で右クリックしてコンテキストメニューを表示、「Javadocを表示」を選ぶとブラウザに表示されます。

なお、JSPはJavadocにはなりません。

 

NetBeans IDEの説明に戻る

新入社員研修ポータル

IT企業の人財育成に関することなら全てお任せ下さい TEL 0120-559-463 受付時間 10:00 - 17:00 (土・日・祝日除く)

ZOOMを使った遠隔研修メニュー(PDFが開きます)

ZOOMを使った遠隔研修

新人エンジニアのためのJavaタイピングゲーム

新人プログラマのためのプログラミング動画

YouTubeチャンネル

お問い合わせはこちらから

お名前 (必須)

メールアドレス (必須)

題名(件名)

メッセージ本文

確認画面は表示されません。上記内容にて送信しますので、よろしければチェックを入れてください。

新入社員研修ポータル

PAGETOP
Copyright © Say Consulting Group, Inc. All Rights Reserved.