Javadocを書く - しげるメモ

最近は時間を作ってEffective Javaの2版をよんでます。 Effective Java (Java Series) 作者: Joshua Bloch出版社/メーカー: Prentice Hall発売日: 2008/05/08メディア: ペーパーバック購入: 6人 クリック: 65回この商品を含むブログ (42件) を見る ほとんど1版と同じ内容ですが、"Item 44: Write doc comments for all exposed API elements" を読んでよくまとまってるなと思ったので、触発されてメモがてらに私のやり方を。 引用の2段落目は基本的に超約。 どこに書くか If an API is to be usable, it must be documented. ユーザが利用可能なすべてのAPIにJavadocを書く。 これはとりあえず必須だと思います。ち

[daira4000]

javadocをどう書くか

[sh2]

Javadocのお作法1

[ocs]

Javadocは書くべし。Javadocを書きやすいサイズのメソッドを設計するのがよい。という話

[shin-uemon]

有用なチェックリスト付き

[satoryu]

ドキュメントはしっかりと書かんと

[fuktommy]

コメントが100行あるとか、テストが50項目もあるとしたら、メソッドとして大きすぎるんじゃないかと思うんだけど。

[scorelessdraw]

java

[wacky]

Javadocは何をどこまで書けば良いか。チェックリスト。

[yuroyoro]

javadocダメ=設計ダメというのは激しく同意。 プラクティス→使い方のサンプルコードを書く。TemplateMethodパターンなどではサブクラス化するときの注意点を書く。

[SiroKuro]

素晴らしい記事／getAttributesは毎回同じSet<String>を返す？ getAttributes()==getAttributes()は真か偽か。加えて本体への変更がSet<String>へ自動反映されるか否か／どう書くjavadoc版とか面白そうな。誰かもんだい出してよ