Javadoc（じゃばどっく） - プログラミング用語・IT用語辞典

サイト内検索：

<Let's create a game!> Introduction of programming for absolute beginners

English

Javadoc（じゃばどっく）

Javadoc（じゃばどっく）

Javaのソースコードから仕様書用のドキュメントを
生成するツールと、そのドキュメント形式のこと。

このAPIドキュメントもJavadocで作られている。

オンラインAPIドキュメント　overview-summaryのページ

http://docs.oracle.com/javase/jp/6/api/overview-summary.html
（オラクル社のページを表示します）

Javadocの書式（関数の場合）

ソースコードにJavadocの開始記号と終了記号を書く。
この間にコメントとタグを必要な分書いていく。

「タグ」はJavadocの項目を表す命令。
@（あっとまーく） + タグ名で書く。

項目の間は半角スペースを空けること。

Javadocのタグの種類（一部）

@param 引数を表す。

@return 戻り値を表す。

タグはJavadocの項目の種類を表す命令
他にもいろいろな種類のタグがある

・関数の上の行に書く。

・項目ごとに半角スペースで区切る。

・コメントもタグも必要なだけ何個でも書ける。

・コメントにはHTMLを使う事もできる。

クイズゲーム完成　解答チェック関数化（Javadoc追加）
（KotoQuizのKQMain.java）168行目～

・・・
168		/**
169		* 解答チェック処理
170		* @param seikaiBangou 正解の番号
171		* @param kaitouBangou 入力番号
172		* @param seikaiGoukei 正解数
173		* @return seikaiGoukei 正解数
174		*/
175		private static int checkAnswerData(int seikaiBangou,int kaitouBangou,int seikaiGoukei){
176
177		//解答チェック
178		if( kaitouBangou == seikaiBangou){
179		System.out.println("やったね！正解");
180		seikaiGoukei += 1;//正解数加算
181		}else{
182		System.out.println("残念！不正解");
183		}
184
185		//結果を返す
186		return seikaiGoukei;
187		}
・・・

ソースコードへの記述例

このJavadoc形式でコメントを書いておくと
IDEに認識されるから便利。

例えば、
今回のコメントを記述した後に、エディタ上で、
CTRL + SPACE を押して補完表示すると、
以下の様に表示されるようになる。

エディタウィンドウ(補完機能表示)

コードからJavadocを生成する

1、ソースコードに必要なタグを記述する。
2、IDEの生成の設定をする。
3、Javadocを生成する。

Javadocの生成の設定

1、「プロジェクトウィンドウ」の任意のプロジェクトを右クリックして「プロパティ」。

2、「ドキュメント化」を選択。

3、「privateおよび・・・」をチェック。

　　その他の設定はデフォルト設定（画像の設定）のままで問題ありません。
　　同じになっているのを確認して下さい。

4、「了解」ボタンを押す。

Javadocの生成

1、メニューの「実行」から「Javadocを生成」を選択。メインプロジェクトのJavadocの生成が始まります。

2、生成後、自動的にプレビューが表示されます。

Javadocファイルの生成される場所は、
後述の「各ファイルの生成場所」で確認して下さい。

※他にも「プロジェクトウィンドウ」の任意のプロジェクトを右クリックして
「Javadocを生成」でも生成できます。

セッションでは今後、関数のコメントには
Javadoc形式を利用します。

余裕が出来たら、どんなタグがあるのか
Javadocのタグ一覧を眺めて見てください。

オンラインドキュメント　javadocのタグ一覧

文字化けする場合は、ブラウザのエンコードをUnicode（UTF-8）に変更して下さい。
（IEの場合は、ブラウザ上で右クリック　→　エンコード　から変更できます。）

このページはセッションで使用したプログラミング用語やIT用語の要約です。復習に利用して下さい。

漫画形式の本編はこちら　＜ゲームを作ろう！＞超初心者のためのプログラミング入門

サイト内検索：

お勧めの姉妹サイト