[seasar-javadoc:602] Re: KPT org.seasar.framework.container.*

[Jundo Ishikawa]

JUNDUです。

　お疲れ様です。先日の打ち上げでは、楽しいお酒を飲むことが出来ました。
是非、第２回を早めにやりましょう。というわけで、Javadocの見直しですが、
とりあえず以下のような観点でいかがでしょうか？

用語/揺らぎの統一
　○○定義などのJavadocを記述する言葉と、カタカナ語の最後の長音記号の
統一。余裕があれば、用語はS2コンテナの記述とも統一？

類似内容の表現方法の統一
　〜Defなどの類似するクラスで説明の仕方が微妙に違うものを統一する。併
せて、あるところでは説明があるのにもう片方ではないことが不自然であれば、
それも統一する。

日本語としてのチェック（てにをは、主語）
　日本語自体がおかしいところのチェック。また、メソッドの説明では基本的
にクラスが主体的に行うこととして表現することになっているが、それが使う
側から見た表現になっていないかどうかのチェック。

記述内容の過不足チェック
　以前、メールでやりとりされた想定読者の期待を満たせるかチェックする。
これが一番難しい気がします(^^;

　他にもありそうな気もしますが、とりあえずこの４つしか出そうに無ければ、
それぞれに２名ずつサインアップしてダブルチェックというのがいいかなと思
いました。

　期限を長くても１週間程度にしてさくっと終わらせてしまいたいですね。是
非、やり方についてご意見をお聞かせください。


-- 
 Jundo Ishikawa <jundo.ishikawa ＠ gmail.com>