Naoki Kurosawa
n-kur****@nri*****
2004年 2月 6日 (金) 13:55:49 JST
黒澤です。
Wikiに、コーディングルール、ネーミングルール等書いておきました。
[FrontPage]-[プロジェクト運営情報]からたどれます。
高田さんと松野さんが私に押し付けたので、
私の環境(Eclipse)でやりやすいようなバイアスが少しかかっています。
JavaDoc記述ルールは元のやつから少し変えました。
変更ポイントは、
・「句読点の後で改行する」の追加
・オーバーライドメソッドのコメント(非JavaDoc)の書き方
元: [定義元スーパークラス名/インターフェース名]のJavaDoc
現: @see [定義元スーパークラス名/インターフェース名#メソッドシグネチャ]
・@auther の記述
元:[ファーストネームのイニシャル].[ラストネーム]
例 N.Kurosawa
現:[ファーストネーム] [ラストネーム]
例 Naoki Kurosawa
以上です。
ところで松野さん
@since 1.0alpha
などと書かないでください。JavaDocは使い手が見るわけで、
使い手が見るのはリリースバージョンのJavaDocのみです。
こういうときは、
@since 1.0
と書きます。
細かいコーディングスタイルは、あとで決めてMavenのcheckstyleプラグインで
一括チェックする予定です。
いちいち書きたくないので、
「チェックに引っかかるものを引っかからないようにせよ」
というルールで。