書籍:「エンジニアのためのJavadoc再入門講座」
昨日、JSUG/JGGUG合同勉強会の懇親会で作者のid:riueさんと少しお話しする機会があったので、この本を紹介したいと思います:
エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方
- 作者: 佐藤竜一
- 出版社/メーカー: 翔泳社
- 発売日: 2009/06/30
- メディア: 単行本(ソフトカバー)
- 購入: 15人 クリック: 263回
- この商品を含むブログ (49件) を見る
あまり大きく取り上げられることはありませんが、javadocはJavaの重要な成功要因の一つだと思っています。最初にJavaに触れてjavadocを知ったときには「言語処理系に最初からドキュメント生成メカニズム/ツールが組込まれているなんて、こりゃクヌース先生の文芸的プログラミングの世界だね!」と感動したものです(実はperldocとかも使ったことありましたが、あれは確かperl5からだったし、当時あまり広範に使われていなかったと思います)。Javaでここまで多彩なAPIが作られ、使いこなされているのも、javadocという統一された共通の文書化基盤あってこそでしょう。(新しいAPI勉強するときって、まず「javadocどこ?」って思いますよね!)
さて、このように重要なjavadocですが、これだけ多くのJava本が出版される中、javadocをメインテーマとして扱った本は記憶にありません。そこで、この本です。実は中身は読んでいないのですが(ぅ)、佐藤さんにうかがった話では、docletの作り方とかそういった方向ではなく、よりよい文書化のためにはどんな情報をどう記述すべきか、というようなガイドライン的な内容になっている、ということでした。うん、Java使いには必携の書になりそうな予感がしますね。献本いただければさらに詳しいレビューをしたいと思います(←買えよ!)。