エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方 [単行本（ソフトカバー）]

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

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

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

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