[seasar-javadoc:523] Re: org/seasar/framework/container/package.html

Koichi Kobayashi koichik @ improvement.jp
2006年 8月 28日 (月) 03:15:39 JST


小林 (koichik) です.

Date:    Thu, 24 Aug 2006 06:37:01 +0900
From:    Hideaki Suzuki <suzuki @ uinet.or.jp>
To:      seasar-javadoc @ ml.seasar.org
Subject: [seasar-javadoc:521] Re: org/seasar/framework/container/package.html

> ご無沙汰しておりましたが夏バテから復活の予感です (^^;;;

夏休みでお出かけしているのかなぁとか思ってましたが,夏バテでしたか.
ご自愛くださいませ.

> org/seasar/framework/container/package.html
> Milestone 2 です。

ありがとうございます.

> 「主要なインタフェースの位置づけ紹介」部分を表にしてみました。
> はじめに、文章で書いてみたのですが、ちと読みづらいかなと思い、
> <dl><dt><dd>で書いたのですが、イマイチと感じたので、<table>
> にしてみました。

これ,Javadoc で生成するとクラス/インタフェース一覧表の後に
また表が続くことになりませんか?
続いても悪いということはありませんが,どうなんだろう?
とはいえ,表が見やすいなら表にするしかないですね.

その表ですが,どうせならインタフェースではなく dicon のタグ名を
一番左に持ってきて,〜Def の隣りに 〜DefAware も並べてみては
どうでしょうか?

そうすると,説明が 〜Def しかないのはいかがなものか?
という気もするのと,説明は Javadoc が生成する一覧にも出てくる
はずなのと,リンク先をたどれば見れるので,こっちの一覧は
説明なしでもいいんじゃないかと思ってみたテスト.

あと,タグ名は &lt;components&gt; のようにしてもらえると
見るからにタグっぽくていいかと思います.

それから,インタフェース名って {@link 〜} 使えませんか?
package.html に使えるのかどうか疑問も感じないではありませんが.
もし使えない場合は <a href="S2Container.html">S2Container</a> で.

> Tigerアノテーションについては、拡張プロダクトなのでここに書くのは
> いかがなものか?とも思ったのですが、自分だったら、ここにまとめて
> 書いてあると便利だなぁ〜と思い、一応入れておきました。

そうですね,S2Tiger を使う人も見るかもしれないので,ここにあって
いいんじゃないでしょうか.

> それから、Milestone 1 の最後の「振舞いも表す」的な部分についてですが、
> 以前、私自身「PropertyDef=プロパティ」と勘違いしていた経験を踏まえて、
> 書いてみたのですが、ちょっと文章の意図がはっきりしないのと、今回は、
> 表の中の説明で「セッターインジェクション」と明確にしているので、
> 削除しました。

そうですね,ここは案内板の役割を果たせれば十分だと思うので,
一覧で十分だと思います.


さて,いよいよリーチがかかってきたというか,打ち上げの準備に着手しなきゃ
いけなくなってきましたね.
北海道の山本さんはさすがに参加頂けないと思いますが,
# 近々上京の予定とかあります?>山本さん
東京近辺にお住まいの方,是非集まって盛大に打ち上げしましょう!!

時期は来週くらい? 09/04〜08 の週のどこかとか.
その次の週だといろいろなイベントがあってひがさんを誘えなくなるので,
来週が無理なら 09/18〜22 の週がいいかも.
皆さんの予定は?


-- 
<component name="koichik">
    <property name="fullName">"Koichi Kobayashi"</property>
    <property name="email">"koichik @ improvement.jp"</property>
    <property name="blog">"http://d.hatena.ne.jp/koichik"</property>
</component>



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