エンジニアの将来って?

現在10年目エンジニアがプログラムの解説、ゲームの研究を書く雑記ブログです

【eclipse】Javadocを生成する方法を解説します

こんにちは。たいら(@tairaengineer2)です。

この記事では、 eclipseJavadocを生成する方法について解説します。

スポンサーリンク

 

前提条件

この記事では、eclipseのバージョンは

バージョン 2020-03 (4.15.0)

を使っています。
インストールの仕方は、下の記事をご参考ください。

www.tairax.com

eclipseでJavadocの生成方法を解説

では、eclipseでJavadocの生成方法を解説します。
まず、eclipseを開きます。

f:id:Tairax:20200430120325p:plain

上のバーにある【ファイル】をクリックします。

f:id:Tairax:20200430120742p:plain

ドロップダウンリストが表示されるので、その中にある【エクスポート】を選択します。

f:id:Tairax:20200430120950p:plain

【エクスポート】という画面がポップアップします。

f:id:Tairax:20200430121134p:plain

ここで

  1. Java
  2. Javadoc

の順番で選択します。

f:id:Tairax:20200430121340p:plain

【Javadoc】を選択している状態を確認して、【次へ】ボタンを押します。

f:id:Tairax:20200430121538p:plain

【Javadocの生成】という画面に切り替わります。
ここで生成するJavadocをいろいろ設定できます。

f:id:Tairax:20200430121819p:plain

【Javadocコマンド】で、【javadoc.exe】が選択されていることを確認します。

f:id:Tairax:20200430142624p:plain

もし【javadoc.exe】が選択されていない場合、【構成】ボタンを押して、

f:id:Tairax:20200430142836p:plain

【javadoc.exe】を探して選択します。

f:id:Tairax:20200430143115p:plain

【Javadocが生成される型の選択】【次の可視性を持つメンバーのJavadocを作成】は、最低限入力と確認をしなければならない箇所です。

f:id:Tairax:20200430122910p:plain

【Javadocが生成される型の選択】では、何のJavaファイルをJavadocで生成するのかが選択できます。
生成したいJavaファイルにチェックを入れます。

f:id:Tairax:20200430123343p:plain

今回は1つしか選択していませんが、複数選択することも可能です。

次に【次の可視性を持つメンバーのJavadocを作成】を決めます。

f:id:Tairax:20200430141538p:plain

【次の可視性を持つメンバーのJavadocを作成】では、Javadocを生成する範囲を決めます。
意味は以下になります。

Private すべてのクラスとメンバーについてJavadocを生成
Package privateのクラスおよびメンバー以外についてJavadocを生成
Protected protectedおよびpublicのクラスとメンバーについてJavadocを生成
Public publicのクラスとメンバーについてJavadocを生成

生成する範囲の決め方として、この仕様書を見るのは誰なのか?というのが1つあると思います。
外部に見せる場合は【Public】、内部でしか使用しない場合は【Private】というようにすると良いと思います。
今回は自習用で私しか使う人がいないため、【Private】を選択します。

f:id:Tairax:20200430141946p:plain

最後の

  • 標準ドックレットを使用
  • カスタムドックレットを使用

と、ありますが基本【標準ドックレットを使用】で問題ありません。

f:id:Tairax:20200430143842p:plain

そもそもドックレットとは、何なのかというとJavadocプログラムです。

ドックレットとは、ドックレット API を使用して JavaTM プログラミング言語で記述した、Javadoc ツールの内容と形式を指定するプログラムのことです。

ドックレットの概要から引用させて頂きました

標準ドックレットとは、最初から提供されているドックレットです。
カスタムドックレットとは、新規作成したり、標準ドックレットをカスタマイズしたドックレットです。
なので、自作のドックレットがある以外は、【標準ドックレットを使用】でOKです。

ここまで確認できたら、【次へ】ボタンを押します。

f:id:Tairax:20200430144946p:plain

Javadocの引数についての画面になります。

f:id:Tairax:20200430145147p:plain

問題ないか確認します。
大丈夫そうでしたら【次へ】ボタンを押します。

f:id:Tairax:20200430145640p:plain

Javadocのオプションが設定できる画面に切り替わります。

f:id:Tairax:20200430145851p:plain

何かオプションを設定したい場合、設定します。
確認し問題なさそうでしたら【完了】ボタンを押します。

f:id:Tairax:20200430150102p:plain

【コンソール】タブでJavadocが実行されているのが確認できます。

f:id:Tairax:20200430150725p:plain

もし何かしらエラーがあったら、確認し修正してください。

異常がなければあっという間に指定したプロジェクト配下に【doc】というディレクトリが作成されています。

f:id:Tairax:20200430150549p:plain

この【doc】ディレクトリを開いてみると、たくさんのHTMLファイルがあります。

f:id:Tairax:20200430151008p:plain

この中の【index.html】を開きます。

f:id:Tairax:20200430151151p:plain

そのまま開いてしまうと、HTMLエディタで開いてしまうため【index.html】を右クリックし

  1. 次で開く
  2. Webブラウザ

を選択します。

f:id:Tairax:20200430151537p:plain

仕様書が作成できていることが確認できました!

f:id:Tairax:20200430151810p:plain

 

スポンサーリンク

 

まとめ:Javadocで仕様書を作ってみよう!

以上がJavadocの生成についての解説でした!

あなたのご参考になったのなら、とても嬉しいです(*´▽`*)
ではでは~(・ω・)ノシ

 

ほかにもeclipseの記事を書いています。
こちらもご参照ください。

【eclipse】コマンドライン引数に値を設定するやり方を解説します【Java】

【eclipse】バージョンの確認の方法を解説します

 

今までブログで書いたJavaの解説記事のまとめは、こちらをご参考ください。

【Java】ブログで書いた文法記事のまとめ