エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方 (単行本（ソフトカバー）)

エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方

Javadocなんてほとんど書いたこと無いので参考になります。以下のようにただ訳しただけのJavadocはよく見るんだけど、これ意味のあるのかな？って前から思ってた。

@param name 名前

なんとなくちゃんとコード書いてる感がでるのはわかるけどw　publicメソッドの引数、戻り値の範囲は確かに重要だね。nullの扱いとかね。あと例外もか。

ただ業務システムの開発だったらJavadocが必要な箇所は限られるのかも。というのもあるユースケース、サブアプリケーションのロジックを別のところで再利用することは無さそうな気がするから。再利用するような共通クラスだったら書く必要有ると思うけど、そういう共通クラスやユーティリティというのは他と比べてそんなにボリューム無いんじゃないかな。フレームワークやライブラリは必要だろうけどね。

でちょっと関連した話としてはJavadocが必要な箇所はユニットテストを書く優先順位も高いのではないかと思っている。再利用される可能性が高いところはドキュメンテーションだけじゃなくて使用例や品質も求められるからね。