[seasar-javadoc:442] Re: IllegalDestroyMethodAnnotationRuntimeException

Koichi Kobayashi koichik @ improvement.jp
2006年 7月 25日 (火) 03:00:31 JST


小林 (koichik) です.

Date:    Mon, 24 Jul 2006 13:09:38 +0900
From:    "Jundo Ishikawa" <jundo.ishikawa @ gmail.com>
To:      seasar-javadoc @ ml.seasar.org
Subject: [seasar-javadoc:438] IllegalDestroyMethodAnnotationRuntimeException

>  お疲れ様です。IllegalDestroyMethodAnnotationRuntimeExceptionの
> Javadocをサラッと書いてみました。

ありがとうございます.

クラスコメントが「不正な〜」で始まるのはいい感じですが,
メソッドコメントで繰り返し登場するとちょっとウゼェ (^^;
って思わなくもないですね.
そんなわけで (どんなわけで?),

>      * @param componentClass
>      *            不正な定数アノテーションが指定されたクラス

こういう「不正な」は削っちゃいましょう.
@return も.

・getComponentClass()

>      * 例外の原因となった不正な定数アノテーションの指定されたクラスを返します。

「アノテーションの」より「アノテーションが」の方が自然な感じが.

それから,鈴木さんが指摘しているように,定数アノテーション以外でも
この例外がスローされるので,「定数」は削りましょう.
とはいえ,「destroyメソッド・アノテーション」も長いので,
ここは単に「アノテーション」でいいんじゃないかと思ったり.


Date:    Mon, 24 Jul 2006 17:30:05 +0900
From:    "Jundo Ishikawa" <jundo.ishikawa @ gmail.com>
To:      seasar-javadoc @ ml.seasar.org
Subject: [seasar-javadoc:439] Re: IllegalDestroyMethodAnnotationRuntimeException

>  ちょっとだけ気になったのは、@linkの中で<var>を使わないほうがよかったの
> かなということでしょうか。とりあえず付けてしまいましたが必要なければ
> 外します。

これは外しましょう.



-- 
<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 メーリングリストの案内