[seasar-javadoc:141] Re: フォーマット
Hideaki Suzuki
suzuki @ uinet.or.jp
2006年 6月 1日 (木) 00:51:41 JST
鈴木(belltree)です。
> ・読点(、) の後ろには (いわゆる) 半角スペースを入れる.
> ・句点(。) の後ろでは改行する.
>
> ということにしませんか?
>
> HTML で表示すると,句読点の後ろに空白が入ってしまうことに
> なりますが,許容範囲だと考えます.
> ソース上での読みやすさと HTML での読み易さの妥協点として
> よい方法ではないかと.
この方法に+1です。
ちょっと気になるのは、例えば、ソースコード上で、見やすい感じに
改行したとして、そのあとに Ctrl+Shift+F でフォーマットした際に、
(短い)経験上「それでも1行が長い」ケースがあったように思います。
「フォーマット後に改行」もありますが「とにかく最後は Ctrl+Shift+F」
原則は絶対です。
最終兵器のフォーマットルールの変更も、パッケージ階層の深い
クラスを記述することなどを考えると、1行80文字は欲しい。
などと考えると、私も、現状ではこの方法がベストだと思います。
/**
* @auther Hideaki Suzuki
* @contact suzuki at uinet.or.jp
*/
seasar-javadoc メーリングリストの案内