[seasar-javadoc:78] Re: ツッコミ大歓迎! 叩き台サンプル

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Mon, 29 May 2006 08:36:05 +0900
From:    Hideaki Suzuki <suzuki ＠ uinet.or.jp>
To:      seasar-javadoc ＠ ml.seasar.org
Subject: [seasar-javadoc:73] ツッコミ大歓迎! 叩き台サンプル

> 【恥を】
> 課題の洗い出しと、Javadoc Wiki に規約として載せるネタ出しのために、
> 自分が追加したJavadocコメント（付きソース）を添付しました。
> 【忍んで】

おぉ，素晴らしい♪

> 遠慮なく突っ込んでやって下さい。宜しくお願いします。
> 
> P.S.1
> 思ったよりもめちゃめちゃ時間がかかりました。

参考までに，ソースを眺めてる時間も含めてどれくらいの
時間がかかったか教えてもらえますか？

> Seasar2の理解が足りない…

これはしょうがないですよね．
といって理解してから書こうとするといつまで経っても
何も書けないことになりかねないので，Javadoc を書いていく
過程で理解できればいいのではないでしょうか．

> Interface=仕様/Class=実装 スタイルの場合、Interfaceの
> Javadocコメントを書くためには、何か思想的なもの掴む必要が
> あるのかなぁ…と感じました。

そうですね，インタフェースだけだと仕様の文法 (syntax) しか
読み取れない場合もあります．
意味 (semantics) を読み取るには実装クラスのソースを読まざるを
得ませんね．
他の Seasar2 ユーザがそうしなくて済むようにするのが
Javadoc Project の意義ということで．



-- 
<signature>
    <name>Koichi Kobayashi</name>
    <e-mail>koichik ＠ improvement.jp</e-mail>
</signature>