[seasar-javadoc:853] Re: ConstantAnnotationHandler

Maeno [E-MAIL ADDRESS DELETED]
2007年 4月 11日 (水) 10:27:07 JST


前野です。

取り急ぎ、確認させて頂きたい事ありますので、返信まで。

>> public なメソッドについてはインタフェースあるいは
>> 親クラスで記述されたものがそのまま適用されるので,
>> このクラスではコメント自体書かないということで
>> いいんじゃないかと思います.
>> 
>> このクラス固有の記述を追加するならできるだけクラス
>> コメントで書く方が読みやすいんじゃないかとも
>> 思いますし.

あぁ・・・。そうだった・・・。
だからjavadocの雛形を作る時に引数(@param hoge)とかが
作られなかったのか・・。

ご指摘を受けて、以下の方針でjavadocの見直しをしようかなと
考えているのですが、問題ありませんでしょうか?
 - publicなメソッドについては特に記述不要
 - クラス固有の記述がある場合はクラスコメント
 - インタフェースあるいは親クラスで定義されていないメソッドが
   あるときはjavadocを記述する

>>> protected void appendAspect(ComponentDef componentDef,
>>>  String interceptor, Method pointcut) {
>>>    (略)
>>> }
>>> このメソッドの引数にMethod poitcutがありますが、
>>> Method methodに修正しては如何でしょうか?
>> 
>> これはポイントカットとして選択されたメソッドという
>> 気持ちかなぁ.でもその意味では joinpoint の方が
>> 適切かも.
>> って悩むなら method にしちゃってもいいかもしれませんね.

個人的にはjoinpointMethodがしっくり来るような来ないような。
もし、修正するのであれば、自分が修正してもよかでしょうか?

以上、よろしくお願いいたします。


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