[seasar-javadoc:231] Re: ComponentDef M1

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Wed, 14 Jun 2006 01:24:20 +0900
From:    Hideaki Suzuki <suzuki ＠ uinet.or.jp>
To:      seasar-javadoc ＠ ml.seasar.org
Subject: [seasar-javadoc:226] Re: ComponentDef M1

> > http://www.w3.org/TR/html4/struct/text.html#h-9.2
> 神がこんな所に… (^^;;; 不覚!

人はそうやって W3C 原理主義者となっていくのです (いみふめ)．

> > 　Spec.によると、変数または引数の具体例となっているようなので、本当は
> > 変数や引数を<var>で囲むのかもしれませんね。OGNLは変数などではないので、
> > ちょっと使いどころではないみたいです(^^;
> var = variable にいまさら気が付きました … 海より深く反省 … orz

変数や引数そのもの (識別子) を表現するなら <code>，その変数や
引数が取りうる値を表現するなら <var> といった感じでしょうか．

<var> の変数というのは数学でいうところの変数のイメージで，
様々な値を表す記号です．こっちは <var>

一方，Java の変数は入れ物に付けられた名前です．こっちは <code>
Javadoc では <var> はそれほど使わないと思います．

> > 　<code>もコードの断片という事なので、本当はもうちょっと長いのに使う
> > べきなのかもしれません。

true とか null なんかでも使うので，長さはあまり関係ないですね．

> > 　ただ個人的には、タグの種類が多いと混乱するので、<var>は使わず<code>
> > だけに統一してしまうというのもありかなと思うのですがいかがでしょうか？
> なるほど。Simple is Best で、それもありかもですね。

実際には <code> もあまり使わないと思いますけどね．

true，false，null．．．

他にあったっけ？
識別子などの多くは <code> ではなく {@link 〜} で書けちゃいますから，
<code>もそんなに使わないんじゃないかなぁ．

メソッドの説明中で，特定の引数を表現する場合は
<code>引数名</code> ですね．


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