
エントリーの編集

エントリーの編集は全ユーザーに共通の機能です。
必ずガイドラインを一読の上ご利用ください。
最近のJava API仕様書生成について - Qiita
記事へのコメント0件
- 注目コメント
- 新着コメント
このエントリーにコメントしてみましょう。
注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています

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