skillup

技術ブログ

Java

Javadocに関して

投稿日:2015年4月19日 更新日:

業務で社内で使うクラスライブラリを作成中です。

他人に使ってもらうものなのでコメントやドキュメント周りの整備が必要になり、javadocをしっかり作りたいと思っています。

javadocとは?

javadocとはJavaのソース内のプロパティやメソッドのコメントをドキュメント化したものです。一般に公開されているJavaのクラスライブラリにも必ずついています。

http://docs.oracle.com/javase/jp/7/api/

このようなJavaのドキュメントをコメントから生成することができます。

Javadocのコメントの書き方

日ごろプログラマの方であればソースにコメントを入れていると思いますが、javadocとしてドキュメントを生成する場合には、決まった書き方でコメントを書くことになります。

プロパティ

メソッド

ちなみにNetbeansだとメソッドの上で/**と書いてEnterを押しますと、自動的に必要な値の入力補完をしてくれます。

あとはこの通りに書いて、プロジェクトで右クリック→「Javadocの生成」で必要なドキュメントが全て作られます。Netbeans便利すぎる・・・

上記フォーマット通りに書かないと逆にコンパイラに怒られることになりますが・・・

また注意点としてはprivateの場合は、ドキュメント化されません。これは外部に公開したくないものなので当たり前といえば当たり前ですね。

-Java
-

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

Javaのstreamまとめ

以前にもちょっと扱ったJavaのStreamに関してまとめ Contents1 過去のリンク2 ソース3 注意事項4 参考リンク 過去のリンク MapのStream http://skill-up-e …

no image

Mapの使い方

Javaに限らずプログラミングで最も大切になるのは配列の処理でしょう。 Javaですと、PHPのような連想配列の代わりにMapを使用します。 Contents1 Mapとは?1.1 Mapのインスタン …

no image

例外処理について その2

以前、「例外処理について」で例外処理について記述をしたんですが、漠然としていたのともう1回まとめなおしたかったため、メモしておきます。 Contents1 例外とは?2 例外のクラス分け2.1 Thr …

no image

dbUnitの使い方

えーJavaで有名なテストツールDBUnitについて。 DbUtilではありませんので間違えないように。(私は最初間違えました・・・) まだ全然使い込んでるわけではありませんがどんなことができるかとい …

no image

JPAでの算術関数の型&mavenコンパイルプラグイン

本日も小ネタなので2つ同時に扱います。 Contents1 JPAの算術関数2 mavenのコンパイル JPAの算術関数 JPAでは以前、MySQLなどと同じように算術関数を使えると書きました。 参考 …