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

佐藤竜一(著者)

• 販売会社／発売会社: 翔泳社
• 発売年月日: 2009/07/01
• JAN: 9784798119489

商品レビュー

2013/03/05

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

2012/06/27

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

2011/04/27

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