商品の詳細

• Amazon.co.jp ランキング: #79746 / 本
• 発売日: 2009-06-30
• 版型: 単行本（ソフトカバー）
• 240 ページ

内容（「BOOK」データベースより）
現場で真に使えるAPI仕様書を作るための解説書。Javadocタグの利用方法はもちろん、「仕様の記述」という観点から、書くべき内容や考えなければならないポイントもチェックリスト形式で完全指南。ソースコードからAPI仕様書を生成する手順や「契約による設計」を支援するツールも紹介。

著者について
「ソースコードがドキュメント」の意味、あなたは正しく理解できていますか?

「Javadoc」とは、JavaのソースコードからHTML形式のAPI仕様書を生成するための
テクノロジーです。多くのJavaプログラマは日常的にJavadocを利用しており、また
その記述方法も広く知られています。しかし、開発の現場で“使えるJavadoc”を目に
する機会はほとんどどありません。記述されてはいるものの、意味のある内容だとは
到底思えないようなJavadocが氾濫しているのです。そこで本書では、優れたJavadocから
得られる多くのメリット(設計の効率化、再利用性の向上、学習コストの低下 etc.)を
示し、これに必要となる知識や書き方についてを徹底的に解説します。Java開発に携わる
方はもちろん、すべてのアーキテクト/プログラマ必読の1冊です。

著者略歴 (「BOOK著者紹介情報」より)
佐藤 竜一
1995年、図書館情報大学図書館情報学部卒業。プログラマ兼アーキテクトとして各種システムの企画・構築から開発標準策定、オブジェクト指向開発のコンサルティングなどを手がける傍ら、テクニカルライターとして雑誌記事や書籍の執筆に従事(本データはこの書籍が刊行された当時に掲載されていたものです)

カスタマーレビュー

JavaDocの勉強が体系的にできる
知っているようで、以外と知らないJavaDocの使い方が
体系的に勉強できます。
Java技術者であればざっとみておくと有益だと思います。
とくにJavaDocコマンドの各種オプションの詳細について解説して
ある本はこの本だけかもしれません。

ただドキュメンテーションコメントのつけ方については、あまりに
過剰・神経質になりすぎても実際の現場では現実的ではないでしょう。
あくまで、理想論としてとらえておくべきだと思いました。

JavaDocを改めて認識
今まで記述したJavaDocに間違いがあることに気づかされた
これを元に社内でのJavaDocの記述基準を作る参考になった。

もやもやしていた部分がすっきりしました
実際のプロジェクトの現場では、「ほとんど意味のないJavadocをよく見かける」ということから本書が書かれたよう
だが、自分の周りでも同じことがあると認識してました。
しかし、具体的にどう改善したらよいのかはっきり意識できていなかった点がよく書かれていると思いました。

・ドキュメンテーションコメントとしてはプログラムの仕様を書くこと。（読む人に伝える必要がある事項）

というような記述内容の視点と、Javaのクラスや設計のケース毎に「このような場面ではこのような点をあいまい
にならないように書くこと」というポイントが書かれていて、分かりやすかったです。

チェックリストや、チェックリストの解説があるので、必要と思うものを取り込めば即改善できるのではないか。
（チェックリストの表現だけでは内容が類推できない点もあるが、内容を読んで必要と思う部分を選択すればよい
と思いました）