[seasar-javadoc:16] Re: はじめまして&宜しくお願いします

Hideaki Suzuki suzuki @ uinet.or.jp
2006年 5月 25日 (木) 03:23:04 JST


鈴木(hidebsd)です。

> 特に異論がないようであれば,org.seasar.framework.container
> あたりから 1 パッケージずつみんなで進めていきたいと
> 思ってます.
賛成です。パッケージ毎に書き方をそろえながら書いていけば、
JavaDocのパッケージのページなどに統一感が出ると思います。

あと、ざっくりとしたガイドラインがあると最後までブレずに統一感のある
ドキュメントになるかと思います。

たとえば・・・
  ・日本語の書き方(です・ます調とか)
  ・HTMLタグの使い方
  ・記述のポイント(目的、機能、関連する機能、など)
  ・サンプル(お手本とするオープンソースのプロダクトやクラス、フィールド、
    メソッド用のテンプレートなど)

私自身、正直、真剣にJavaDocを記述したことが少ないので(オイオイ^_^;;;)
素人考えですが、いかがでしょう。
ただ、準備に時間を掛け過ぎて、本作業が遅れないようにしないとですね…

P.S. JavaDoc関係で良い本を知っている方がいたら教えて下さい。

/** 
 * @auther Hideaki Suzuki
 * @contact suzuki at uinet.or.jp
 */



seasar-javadoc メーリングリストの案内