javadocでのAPIドキュメント作成

JAVAでプログラミングする場合、多 くがWeb形式のJAVA_APIリファレンスを見ながら作業するでしょう。 自分の作ったプログラムでも、このAPIリファレンスと同じ書式のjavadocを手軽に作成することができます。 javadocを作成するには、各プログラムのソースコードに決められた書式でコメントを記入、javadocコマンドでWeb形式のAPIリファレンス を自動生成してくれます。 javadocで作成されるドキュメントで必要な情報は、大まかに以下の物があります。 package----ClassがPackageに属する場合は、Package概要を明記する。 class------Classの概要、使用方法、作者、関連クラスなどを明記する。 method-----Methodの概要、引数、返り値、例外などを明記します。 classとmethodセクションは、それぞれの

[alumis]

パッケージについてもjavadocが使えることを示している