はてなブックマーク

エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方 作者: 佐藤竜一出版社/メーカー: 翔泳社発売日: 2009/06/30メディア: 単行本（ソフトカバー）購入: 15人 クリック: 263回この商品を含むブログ (49件) を見るJavaDocで一冊本が書けるのか！？という驚き半分、興味半分で読んでみました。私の知り合いでJavaDoc厨と呼ばされている人がいて、その人に色々教えてもらったことを整理して本にした感じで、非常に良くまとまっているし現場で使えるTIPSばかりです。 いくつか例をまじえてご紹介 「メソッド名の日本語訳」はいらない！ 例えばこんなのやつ。 /** * 従業員を検索します。 */ List<Emp> findEmpAll(String id); こんなJavaDocはまったく意味がない。むしろ書かない方がよい。本書には以下のように記述され