[T-struts-dev 25] Re: JavaDocルール

Zurück zum Archiv-Index

Masanori Takata m4-ta****@nri*****
2004年 1月 26日 (月) 10:41:31 JST


高田です。

> 黒澤です。
>
> 「JavaDocコメント内には改行を入れない」というルールですが、
> 1行が長くなりすぎて読みづらいので、
> 「80桁に収まるよう改行を入れる」
> に変更しませんか?

これはですね、例えば、

/**
 * ほげほげで
 * ふにゃふにゃです。
 */

と改行を入れてJavaDocを書くと、HTMLを生成した時に、

ほげほげで ふにゃふにゃです。

という感じに、「ほげほげで」と「ふにゃふにゃです。」の間に
半角スペースが入ったりします。
これを回避するには、改行しないか、

/**
 * ほげほげで
 *ふにゃふにゃです。
 */

のように、「ふにゃふにゃです。」の前に半角スペースを入れない
ように書く必要があります。
でも、大抵のIDEはJavaDocを書く時に、半角スペースを入れてくれます。
なので、「改行しない」というルールが良いかなぁと。

JavaDocは、基本的にはソース上で読むものではないですし。
HTMLを生成した時に綺麗な方が良いかなと。

> #横スクロールするのは苦痛。
>
> Nimbusも同様。
>
>
> _______________________________________________
> T-struts-dev mailing list
> T-str****@lists*****
> http://lists.sourceforge.jp/mailman/listinfo/t-struts-dev

以上。




T-struts-dev メーリングリストの案内
Zurück zum Archiv-Index