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

ApacheCommonsのライブラリ

先日のエントリーでBeanUtilsが非常に使えるという話をしたのですが、それ以外にもApacheCommonsのライブラリには使えるものがかなりあります。 かなりあります、というかなぜ今まで使ってな …

no image

Annnotationについて その2

Java(JavaEE)をやりだして半年ぐらいたつんですが、個人的に鬼門だとおもっていたのが下記内容です。 MVCではないコンポーネントの考え方 クラスを使ったジェネリクスの使い方(型パラメータなど) …

no image

JSPでのカスタムタグ

前回のインク―ドですが、文字列以上の情報を渡すことはできませんでした。 いろいろ調べたり、上司に聞いてみるとカスタムタグという独自のタグを作る機能があるとのことでさっそく調査。 Contents1 カ …

no image

RedmineAPI活用法

自社ではRedmineで基本的にタスク管理をしておりまして、チケット作成に手当がついたりします。 Redmine単体でもいろいろな機能があるのですが、 今月の作成したチケットと完了したチケットを手当と …

no image

JSF+ajax

JSFでajaxを使うときにいろいろと調べたのでメモ。 やろうとしたことはWEB上で給与明細の計算をしたくて、プルダウンで月の変更したら自動的に経費が該当月に替わるというシステムです。 ajaxを使う …