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

開発環境と本番での設定ファイル変更

開発と本番で設定ファイル自体(web.xmlなど)はわけると思うのですが、以前はわからず、開発のものと本番のものを手動でわけていました。 Javaでどうやってやるかを調べたところ、pomにかなり便利な …

no image

JSFでのCSVダウンロード機能

JSF+CDIでCSVダウンロード機能を実装するときの処理です。 結構、汎用的でいろんなところででてきますね。 Contents1 コード2 参考リンク コード [crayon-61762c52bda …

no image

Netbeansのショートカット

超小ネタ。 Netbeansでのショートカットなど。 Contents1 整形2 サーバーログ消し&拡大3 インポートの挿入4 矩形選択5 関数の呼び出し元に戻る 整形 ショートカット(Alt+Shi …

no image

JSPでのインクルード

JSPで社内アプリを作る機会があったので、メモ。 基本的なこともまだわかっていないんですが、とりあえずでてきたものから紹介してきます。 インクルードから。 ヘッダー、フッターみたいな別々に分けたりする …

no image

Javaでのメール送信プログラム

Javaでメール送信のプログラムがあったんで、メモ。 SMTPの認証とかはせず一番簡単なパターンです。 ケースでいうとサーバーA、サーバーBがあり下記のようなケースです。 A メールサーバー(smtp …