エンジニアのためのjavaDoc再入門講座

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

javaDocだけで一冊書いたことがすごい。
ごま油で一冊料理本出しましたみたいな。

javaDocの記載方法としてもですが、すぐれたAPI仕様書を書くには？という観点で読むととても勉強になりました。

特に下記は意識して取り組もうと思います。

• 契約による設計（事前条件・事後条件・不変条件）を明確に記すこと。
• 引数、戻り値の定義域を明確に記すこと。