[seasar-javadoc:175] Re: AccessTypeDef

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Sun, 04 Jun 2006 04:08:48 +0900
From:    Hideaki Suzuki <suzuki ＠ uinet.or.jp>
To:      seasar-javadoc ＠ ml.seasar.org
Subject: [seasar-javadoc:170] Re: AccessTypeDef

> AccessTypeDef Javadoc RC1 添付しました。 (^^;;

コメントを書いている間に RC3 まで届きました．(^^;
精力的に頑張って頂いて，頭が下がります m(_ _)m

> ・「コンポーネント」に統一

今後もこれでいきませう．

> ・“「”と“」”を除く

〜Def の列挙の場合はリンクにできると思うので，「」なしで
{@link 〜} でいきませう．

> ・<p></p>タグの使い方（またまた迷った君）
>   各説明文において、意味的にまとまっている（と信じている）文章に分けて、
>   <p></p>で囲ってみました。ただし、１文で終わるものが多いので、
>   煩雑さを避けるため、最初の１文は<p></p>タグで囲まないという方針に
>   してみました。もっと良い使い方・方針があれば、教えてください。

自分も以前からこうしてます．
でもでも，これって <p> を区切りに使っていた時代の名残のような
気もします．
<p>〜<p> と書くようになってからは，最初の 1 文を囲まないのは
不自然じゃないかという気がしないでもない．
でもでも，JDK でも囲んでないのですよね．
考え方としては，Javadoc 全体を囲む <p>〜</p> が暗黙的に存在して，

<p>
全体の総括
<p>詳細な説明</p>
<p>詳細な説明</p>
・・・
</p>

ということなのかもしれません．


> P.S
>   Java言語もきちっと書こうとすると大変ですが、日本語も大変ですね。
>   わたしだけ？

日本語の方が難易度高いと思います．(^^;


以下，RC3 へのコメントです．

>  * <dd>プロパティ(<var>getter</var>/<var>setter</var>)によるアクセスを表します。</dd>

今更ですが，ここは

 * <dd><var>getter</var>/<var>setter</var>メソッドによるアクセスを表します。</dd>

の方がいいような気がしてきました．

>  * アクセスタイプ定義は{@link PropertyDef プロパティ定義}の属性です。

最初の文がちょっと唐突な感じがするのと，順番的にファクトリの方が
先に来た方がいい気がするので，PropertyDef は @see で済ましちゃっても
いいかも．

今更のコメントでごめんなさい．m(_ _)m


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