エンジニアのためのJavadoc再入門講座
自分も相当なJavadoc厨と自負しておりますので,内容をあらためねばと超上から目線で立ち読みしてきたら,{@code}タグやら@{literal}タグなど,知らないタグが書いてあって,恥ずかしい思いをしたでありますの巻。
慢心はいけませんね。:-P
今までJavadocの書き方といえば「How to Write Doc Comments for the Javadoc Tool」くらいで,とっても良いこと書いてあるのに読んでくれる人は少なくて悲しい思いをしたもんだが,日本語で解説してある本書がでたから,もう安心だね。遠慮して「再入門講座」ってあるけど「再」は余計だよね,つーか,みんなJavadocナメ過ぎ。あれは,相当デキる子なんですよ。
思い返せば,うんこなJavadoc(を作っているプロジェクト)に対する不満は山のようにあるが,そんなの書いてもしようがないので,「Javadoc,よくわかんね」って人は,とりあえず買っとくといいよっ!!
エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方
- 作者: 佐藤竜一
- 出版社/メーカー: 翔泳社
- 発売日: 2009/06/30
- メディア: 単行本(ソフトカバー)
- 購入: 15人 クリック: 263回
- この商品を含むブログ (49件) を見る
ps.
結局のところ,ドキュメントの質なんてのは,書き手が読み手のことをどんだけ考えてあげれるかに左右されるからねぇ。こればっかはお作法だけでは身に付かんけど。:-(