最近のJava API仕様書生成について - Qiitaこの記事はブログに投稿されたものの転載です。 最近のJava API仕様書生成という見地からまとめてみました。 なんでAPI仕様書なのか？ オブジェクト指向にはカプセル化という概念があり、クラスメソッドを呼んでやれば期待する値が返ってくる構造になっています。ただし、引数として何を渡せば良いのか、どのような値が返ってくるのか、異常時にどの様な例外処理が発生するのか等々を事前に把握しておかないと、場当たり的にコードを書き散らすことになります。そこで、きちんとAPIを定義しておき、利用者が無駄なく安心してクラスメソッドを利用できるようにしておくワケです。そのためAPI仕様書が必要なのです。 JavaDocの利用 ここからは現在プロジェクトで利用しているAPI仕様書の生成手順について説明しましょう。 まずは皆さんご存知のJavaDocです。JavaDocフォーマットのコメント元にAPI仕様書を生成
