[seasar-javadoc:18] Re: ガイドライン

[Jundo Ishikawa]

JUNDUです。

06/05/25 に Koichi Kobayashi<koichik ＠ improvement.jp> さんは書きました:
> 小林 (koichik) です．
>
> Date:    Thu, 25 May 2006 03:23:04 +0900
> From:    Hideaki Suzuki <suzuki ＠ uinet.or.jp>
> To:      seasar-javadoc ＠ ml.seasar.org
> Subject: [seasar-javadoc:16] Re: はじめまして＆宜しくお願いします
>
> > > 特に異論がないようであれば，org.seasar.framework.container
> > > あたりから 1 パッケージずつみんなで進めていきたいと
> > > 思ってます．
> > 賛成です。パッケージ毎に書き方をそろえながら書いていけば、
> > JavaDocのパッケージのページなどに統一感が出ると思います。
>
> 1 票ゲット！！

　私も、基本的な進め方として、そんな感じで初めてみるのがいいと思います。

（引用一部省略）
> > P.S. JavaDoc関係で良い本を知っている方がいたら教えて下さい。
>
> 古典 (？) としては
>
> 「The Elements of Java Style (isbn0-521-77768-2)」
>
> でしょうか．
> 他によいものがあればコメントお願いします．

　Effective Javaの項目28にもJavaDocについての記述があります。JavaDocに何を
書いておくべきかが分かりやすく説明されています。これを読んだ後、SDKのJavaDoc
を読むとイメージがつきやすい気がします。