skillup

技術ブログ

Java

Javadocに関して

投稿日:

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

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

javadocとは?

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

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

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

Javadocのコメントの書き方

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

プロパティ

/**
* サンプル文字列
*/
public String;

メソッド

/**
* ここにメソッドの説明文を書きます。
*
* @param fileName プロパティの説明
* @return 戻り値の説明
*
*/
public String  getSample(String fileName){

}

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

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

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

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

-Java
-

執筆者:


comment

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

関連記事

no image

リフレクション

前回のエントリーでは動的にクラスを使いまわす方法について書いたのですが、同様にリフレクション(動的にインスタンスを生成する方法)という技術についても学びました。 社長いわく黒魔術みたいなものといってい …

no image

例外処理について その2

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

no image

サーブレットのスコープ

JavaEEではスコープアノテーションによって変数のスコープを使い分けられたのですが、サーブレットの場合はプログラムの中で使い分けます。 通常はページ、リクエストとセッション、アプリケーションぐらいで …

no image

JAXRSによるRESTAPI作成方法

業務でJavaによりWEBAPI(Rsetful API)を作成する機会ががあったのでちょっとメモしておきます。 Contents1 RestAPIとは2 プログラムの作成方法について RestAPI …

no image

glassfishとDB接続 ~CUI操作~

JavaEEではDBを使うときにglassfish内で設定が必要です。 基本的にはGlassFishでDB接続などのようにブラウザで管理画面から情報を入力することが可能です。 ただCUIや設定ファイル …