Javadocの書き方本!
即ポチですよ、こりゃ。
エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方
- 作者: 佐藤竜一
- 出版社/メーカー: 翔泳社
- 発売日: 2009/06/30
- メディア: 単行本(ソフトカバー)
- 購入: 15人 クリック: 263回
- この商品を含むブログ (49件) を見る
自分は、知ってる人にはdnbkされるくらいのJavadoc厨。書かなければならないことはなんとなく分かっているが、体系的に理解しているとは言いがたい。
そして、内容に限らず、どんな「スタイル」で書いたら良いかは全くわからん…。1行目にHTMLタグは使うべきか否か、とか、本文とjavadocタグの間には空行をいれるべきか、とかw これはJavaAPIのJavadocを真似ようと思ったのだが、JavaAPIのスタイル自体がカオスだったというオチだったw
まぁ、そんなことには言及されていないかもしれないが。まぁ即買いの一品です。