[seasar-javadoc:621] Re: ComponentCustomizer

Hideaki Suzuki suzuki @ uinet.or.jp
2006年 10月 7日 (土) 03:46:28 JST


鈴木(belltree)です。

> > ルールとして
> >   Rule 1. プログラム作者/更新者(Javadocを書いていても) ⇒ "@author foo"
> >   Rule 2. Javadoc専門ライター ⇒ "@author bar (Javadoc)"
> >   ※ ポイントは "(Javadoc)" は "Javadocのみを書いている人" を表す点でしょうか
> > 
> 今更なんですが、(Javadoc)は、いらない気がします。
> ソースのauthorということにかわりはないので。
"(Javadoc)" の記述がないと 
 「へっへ〜、オレ Seasar2本体のコミッター なんっだぜ〜!」
とオレオレ詐欺罪に問われかねないことを言ってしまいそうな自分が怖いです (^^;;;

しかしながら、Javadocは "仕様" なので、確かに "仕様を書いている" と
いえなくもないような(後書きですけど…)。
とすると、ソースの "author" と言えなくもないような…。

"(Javadoc)" を記述するメリット/デメリットは…
■メリット
 ・コアコミッターかJavadocコミッターかの区別が付く。
■デメリット
 ・ "(Javadoc)" が、Javadoc "しか" 書いていない人なのか、
   Javadoc "も" 書いている人なのか、紛らわしい。
 ・"(Javadoc)" を書く手間がかかる (オイオイ…)

という感じでしょうか? 他のプロジェクトでは、Javadoc専業主夫がいる場合
どう書いているのだしょう…?

個人的には、(Javadoc) が無くなると、
「もっとちゃんとコードの内容理解しとかないとマズイなぁ…」
ということで、+の作用が働きそうな気のせいもします… (本当なのか?)

p.s.
実力が伴っていないので、微妙に後ろめたさを感じるような気のせいも… ^^;;

/** 
 * @auther Hideaki Suzuki
 * @contact suzuki at uinet.or.jp
 */



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