某巨大掲示板
なんか,一日中レスが飛び交っていたようで.みんな夏休みなの? (^^;
随分とダメ出しされちゃってますが (苦笑),ドキュメントも JavaDoc もサンプルも,できるだけ充実させたいとは思ってます.
1 行コメントという話が出てますが,クラスコメントについてはひがさんが書いていくことになりました (メソッドは対象外).
すでに,org.seasar.framework.container.assembler
パッケージのクラスにはコメントが入ってます.
1 行ずつね.(^^;
Javadoc については,Javadoc プロジェクトによって少しずつですが着実に進んでいます.
今は最初のパッケージとして org.seasar.framework.container
パッケージ (直下) の Javadoc を書いていて,あと少しでこのパッケージは完了です.
その次は org.seasar.framework.container.factory
パッケージに進む予定.
その前に打ち上げね♪
ドキュメントやサンプルについては 9 月頃から集中的に取り組む予定です.
Seasar2,Teeda,S2Hibernate-JPA,Kuina-Dao を含めた Chura としてサンプルとチュートリアルやリファレンスなんかを揃えていきたいと考えています.
クラス図なんかは考えてなかったけど,大した手間じゃないと思うので書^h描いてもいいかも.忘れなければ (苦笑).
他にもどんなドキュメントがあるといいのか,具体的な提案があれば是非♪
ドキュメントがない,とよく言われちゃうのですが,S2 についてのドキュメントはそれなりにあると思うんですよね.
でもでも,目次とか構成の問題とかで調べたいところにたどり着けないといってのはあるかも.
リファレンス的な,機能に沿った構成だけじゃなく,逆引きみたいに「〜をするには」みたいな構成もあった方がいいのかなってのは考えてます.
そんなわけで (どんなわけで?),できるだけ皆さんの希望に添えるように頑張りたいとは思ってますが,なんたってリソースが限られているので,ご協力頂けると嬉しいです.(^^;
Javadoc プロジェクトはいつでもメンバー募集中です.ソースを読んで理解するにはいい活動だと思いますよ♪ 参加表明は seasar-javadoc ML まで.
整理されていませんが,サンプルプロジェクトへの応募もお待ちしてます.S2Struts + Mayaa + S2Dao のペットショップとか (笑).
Seasar-Wiki には FAQ のページを用意しています.どなたでも書き込めるようになっているので,どんどん書き足して頂きたいな♪
P.S.
個人的には S2JMS/S2JCA のドキュメント頑張らないと.
コードは GW 頃には概ね出来上がっていたのに,ドキュメント未着手のままずるずる...
このままだとプロジェクト閉鎖の危機? (^^;
S2JMS はイベントドリブンだから,秋の Seasar Conference 目指して頑張るしか!!
それから,S2Hibernate-JPA と S2TopLink-JPA を含めた S2 の JPA サポートについてのまとめサイトみたいなのが欲しいかなぁ.
いっそ S2JPA とか? (^^;
S2-Tiger の中でもいいんだけど.