エンジニアのためのJavadoc再入門講座: 現場で使えるAPI仕様書の作り方

著者 : 佐藤竜一

• 翔泳社 (2009年7月1日発売)

作品紹介・あらすじ

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

感想・レビュー・書評

[tatesukeさんの感想 · 2010年5月10日]

これはお勧め。

Javadocの書き方というのも参考にはなるけど、
それよりも「意味のあるドキュメントとは何か」というのがよく分かった。

[Cognosce te ipsumさんの感想 · 2019年1月20日]

javadocが有用であるかはともかく、丁寧に書かれていてリファレンスとしても役に立つ。

[ちのはらさんの感想 · 2013年3月5日]

javaのプログラミングする人なら一読する価値あり。
全部が全部すぐに使えるものではないけど、
明日にでも、クラスとメソッドのJavadocくらいキチンと
読み手に情報が提供できるように書こうと思いました。

[shitai246さんの感想 · 2012年7月25日]

Java屋は読んでおいて損はない。

[B君さんの感想 · 2012年6月27日]

javadocの考え方を見直すきっかけになった。
確かに、ドキュメントでしか表現できなのはある。
たとえば、引数がnullの場合にこのメソッドはnullを返すか、空文字を返すか、NullPointerExceptionなのか、など。。
ソースをみろとはいいずつ、ソースだけではわからないのも確かにある。

[fumikonyさんの感想 · 2012年5月5日]

気になる

[zourockさんの感想 · 2011年4月27日]

「ドキュメントがメソッド名の単なる日本語訳になっていませんか？」などドキッとさせられる指摘が多かった。ドキュメンテーションコメントはなんのために書くのかを考えさせてくれます。

[sue445さんの感想 · 2010年10月19日]

誰が読んでも分かりやすいコメントを書くための方法が書かれた本。中～上級者向け。
実際のJDKのJavadocを例にとっているのが非常に分かりやすいです。

[crandimbooksさんの感想 · 2010年5月15日]

ドキュメンテーションコメントとは、コメントの形式で記述された仕様書。

著者プロフィール

さとう りゅういち
1958年岩手県生まれ。一関第一高校を経て法政大学法学部卒業。東京での編集
　　　者・記者生活を終えて、帰郷。岩手に関する郷土出版物の編集者を経て、2009年
　　　10月より岩手大学で「日本の文学」（宮沢賢治入門）を講義している。
著書　『黄瀛―その詩と数奇な生涯』（1994年、日本地域社会研究所）
　　　『宮沢賢治の東京―東北から何を見たか』（1995年、日本地域社会研究所）
　　　『日中友好のいしずえ―草野心平・陶晶孫と日中戦争下の文化交流』（1999年、日
　　　　本地域社会研究所）
　　　『世界の作家 宮沢賢治―エスペラントとイーハトーブ』（2004年、彩流社）
　　　『盛岡藩』（2006年、現代書館）
　　　『宮澤賢治　あるサラリ－マンの生と死』（2008年、集英社）
共著　『帆船のロマン―佐藤勝一の遺稿と追想』（2002年、日本エスペラント学会）
　　　『灼熱の迷宮から。』（2005年、熊谷印刷出版部）
　　　『ずっぱり岩手』（2007年、熊谷印刷出版部）
　　　『戊辰戦争を歩く』（2010年、光人社）
　　　『柳田国男・新渡戸稲造・宮沢賢治―エスペラントをめぐって』（2010年、日本
　　　　エスペラント学会）ほか
共訳 『三国志　中国伝説のなかの英傑』（1999年、岩崎美術社）

「2010年 『変わる中国、変わらぬ中国』 で使われていた紹介文から引用しています。」