[seasar-javadoc:131] フォーマット

Koichi Kobayashi koichik @ improvement.jp
2006年 6月 1日 (木) 00:00:47 JST


小林 (koichik) です.

Javadoc コメントのフォーマットについて,1 行が長くなりすぎて
エディタ上で読みにくい問題への対処法が見つかりました.

それは,句読点の後に空白 or 改行を入れるということです.
すると,行が長いと空白 or 改行のところで改行されます.

そこで,

・読点(、) の後ろには (いわゆる) 半角スペースを入れる.
・句点(。) の後ろでは改行する.

ということにしませんか?

HTML で表示すると,句読点の後ろに空白が入ってしまうことに
なりますが,許容範囲だと考えます.
ソース上での読みやすさと HTML での読み易さの妥協点として
よい方法ではないかと.


-- 
<signature>
    <name>Koichi Kobayashi</name>
    <e-mail>koichik @ improvement.jp</e-mail>
</signature>



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