エンジニアのためのJavadoc再入門講座 の商品レビュー

佐藤竜一(著者)

2013/03/05

javaのプログラミングする人なら一読する価値あり。
全部が全部すぐに使えるものではないけど、
明日にでも、クラスとメソッドのJavadocくらいキチンと
読み手に情報が提供できるように書こうと思いました。

2012/06/27

javadocの考え方を見直すきっかけになった。
確かに、ドキュメントでしか表現できなのはある。
たとえば、引数がnullの場合にこのメソッドはnullを返すか、空文字を返すか、NullPointerExceptionなのか、など。。
ソースをみろとはいいずつ、ソースだけではわからないのも確かにある。

2011/05/03

「ドキュメントがメソッド名の単なる日本語訳になっていませんか？」などドキッとさせられる指摘が多かった。ドキュメンテーションコメントはなんのために書くのかを考えさせてくれます。

2010/11/27

誰が読んでも分かりやすいコメントを書くための方法が書かれた本。中～上級者向け。
実際のJDKのJavadocを例にとっているのが非常に分かりやすいです。

2010/05/10

これはお勧め。

Javadocの書き方というのも参考にはなるけど、
それよりも「意味のあるドキュメントとは何か」というのがよく分かった。