[seasar-javadoc:190] Re: ArgDef

[Makoto Yonezawa]

米澤です。

毎回、ほんとうにありがとうございますm_ _m
小林さんの的確な指摘のおかげでがんばれてる気がします。

ということで、
もう一度、送ります。

よろしくお願いします。


06/06/05 に Koichi Kobayashi<koichik ＠ improvement.jp> さんは書きました:
> 小林 (koichik) です．
>
> Date:    Mon, 5 Jun 2006 12:48:49 +0900
> From:    "Makoto Yonezawa" <stratosphire ＠ gmail.com>
> To:      seasar-javadoc ＠ ml.seasar.org
> Subject: [seasar-javadoc:182] Re: ArgDef
>
> > 米澤です。
> > すこしとまってしまいしました・・・。
>
> マイペースでやって頂いて大丈夫ですよ．
> 無理しても続かないと思いますし．
> それより，淡々とでも着実に進む方がありがたいです．
>
> > 今日はサボって、喫茶店でSeasarDocumentに専念です（ｗ
>
> (^^;;;;;
>
> そんなわけで (どんなわけで？)，つっこみです．
>
> >  * コンポーネントのコンストラクタ、メソッドに与えられる引数の定義するためのインターフェースです。
>
> 「引数の定義するための〜」は日本語になってないような．(^^;
> 「引数定義のための〜」かな．
>
> >      * 引数の値を返します。
>
> 「引数」だけだと ArgDef の意味と普通のメソッドなんかの
> 引数の意味とごっちゃになりそうなので，「引数定義の値」
> とかにした方が特別感があってよいかも．
>
> >      * コンストラクタや初期化メソッド等の引数値になるもの。
>
> 説明を加えるならもう少し丁寧な感じがいいかな．
> あと，です・ます調にするのと，最初の「〜を返します」と
> 別の段落にするなら <p>〜</p> してください．
>
> >      * @return value
>
> @return は「〜を返します」に合わせてください．
> この場合は「引数の値」あるいは「引数定義の値」．
>
> >      * 値を設定します。
>
> ここは getter と合わせてください．
> 上の例だと「引数の値を設定します」あるいは
> 「引数定義の値を設定します」．
>
> >      * @param value - 値
>
> ここも「〜を設定します」に合わせて「引数の値」あるいは
> 「引数定義の値」．
> っていうか，「value」と「値」の間にあるハイフンは何？
>
> 以下，getter/setter に関しては説明と @param，@return を
> 合わせてください．
>
> >      * 式、式評価の値、子要素のいずれか存在する場合、<code>true</code>を返す。
>
> getValue() を「引数の値」にしたならここもそれで．
> それから，です・ます調で．
>
> >      * @return 式、式評価の値、子要素のいずれか存在する場合、<code>true</code>を返す。すべてが<code>null</code>のときは<code>false</code>。
>
> 「式評価の値」は同上．
> あと，boolean のメソッドの @return は
>
> 〜の場合は<code>true</code>、そうでない場合は<code>false</code>
>
> というのが JDK でよく出てくるパターンになります．
>
> といったところでしょうか．
> あと少しでコミットできるところまでいきそうなので
> 頑張ってください．
>
>
> --
> <signature>
>    <name>Koichi Kobayashi</name>
>    <e-mail>koichik ＠ improvement.jp</e-mail>
> </signature>
>
> _______________________________________________
> seasar-javadoc mailing list
> seasar-javadoc ＠ ml.seasar.org
> https://www.seasar.org/mailman/listinfo/seasar-javadoc
>


-- 
-----------------------------
http://d.hatena.ne.jp/vestige/
http://www001.upp.so-net.ne.jp/vestige/
-------------- next part --------------
/*
 * Copyright 2004-2006 the Seasar Foundation and the Others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.seasar.framework.container;

/**
 * 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
 * 
 * @author higa
 */
public interface ArgDef extends MetaDefAware {
    
    /**
     * 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     * <P>
     * 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓dicon〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓<code>Component</code>〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓<code>arg</code>〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     * 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     * </P>
     * @return 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     */
    public Object getValue();

    /**
     * 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     * 
     * @param value 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     */
    public void setValue(Object value);

    /**
     * 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓S2〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     * 
     * @return 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓S2〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     */
    public S2Container getContainer();

    /**
     * S2〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     * 
     * @param container S2〓〓〓〓〓〓〓〓〓〓〓〓
     */
    public void setContainer(S2Container container);
    
    /**
     * 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     * 
     * @return 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     */
    public Expression getExpression();

    /**
     * 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     * 
     * @param expression 〓〓〓
     */
    public void setExpression(Expression expression);

    /**
     * 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓<code>true</code>〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     * 
     * @return 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓<code>true</code>〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓<code>false</code>
     */
    public boolean isValueGettable();

    /**
     * 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     * 
     * @param componentDef 〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓〓
     */
    public void setChildComponentDef(ComponentDef componentDef);

}