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

フィールド以外のプロパティをエンティティに持たせる

JPAでは基本的に1テーブル、1クラスです。 このためプロパティは必然的にテーブルのフィールドに対応しています。 ただ、必ずしもプロパティだけでなく、臨時で持たせておきたい、プロパティがあったりします …

no image

mavenのゴール

以前、pomに依存ライブラリを記述しましたが、コンパイルのときのみクラスパスが通っており、実行時にはクラスパスが通っていない、NoClassDefFoundErrorがでたことがありました。 気づいた …

no image

データベース文字コード対策他

Contents1 JDBC文字化け対策2 BigDecimal2.1 ソース2.2 参考リンク3 CreateQuery4 jsfのconvertNumber JDBC文字化け対策 データベースがu …

no image

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

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

no image

入出力操作

Javaの出力処理について書きます。 下記リンクが非常に詳しかったので、これをもとにまとめてみたんですが、咀嚼できてないっぽい・・・・ もう1~2度修正がひつようかも。 Contents1 Javaの …

アーカイブ