谷本 心 in せろ部屋

はてなダイアリーから引っ越してきました

エンジニアのためのJavadoc再入門講座を読んだ。

後輩に読ませたい一冊になりそうなので、早速買って読んだ。

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

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


JavadocってEclipseが自動補完してることもあって
「知ったかぶり率がかなり高い」文法の一つだと思うんだけど、
そんな知ったかぶりしてる人が、まさに再入門するために最適な一冊。
Javadocについて網羅的に書かれていて、
教科書的に、チェックリスト的に利用できそうだった。


http://d.hatena.ne.jp/yamkazu-book/20090706
この辺のサイトに例を交えて詳しく書いてあるので、
興味がある人は見てみると良いと思う。


難点を挙げるとすると、教科書的、チェックリスト的な本が抱える弱点そのまま、
つまり、各項目の重要度(優先度)や、現場投入するときの勘所が分かりにくいところ。
この本に書かれていることを、1から10まで実践するのはコストが高すぎるから
プロジェクトやプロダクトの質によって、どこまで書くかは自分たちで決めなきゃいけない。


もちろんそれは、現場のエンジニアの仕事だ、というのもよく分かるけど、
せっかく筆者自身に標準化などの経験があるのだから、
その辺りの思想が本にもう少し表れていると良かった、、、というところ。


まぁそれでも、これまでになかった分野の本だし、良著には違いない。
職場に置いておきたい一冊。