Javaコーディング标准.doc

　本ドキュメントは、(株)永和システムマネジメント平鍋健児氏より提供されているJavaコーディング標準の一部を改変したものです。 オリジナル：http://ObjectClub.esm.co.jp/eXtremeProgramming/CodingStd.doc 目次　LiCS-XP Javaコーディング標準 1 1. 方針 5 2. 命名規則 5 (1) パッケージ名 5 (2) ファイル名 5 (3) クラス名 5 (4) 例外クラス名 6 (5) インターフェイス名 6 (6) 実装クラス名 6 (7) 抽象クラス名 6 (8) 定数(static final) 6 (9) メソッド名 7 (10) ファクトリメソッド(オブジェクトをnewするもの) 7 (11) コンバータメソッド(オブジェクトを別のオブジェクトに変換するもの) 7 (12) 属性の取得メソッド 7 (13) 属性の設定メソッド 7 (14) boolean変数を返すメソッド 7 (15) boolean変数 8 (16) 英語と日本語 8 (17) 名前の対称性 8 (18) ループカウンタ 9 (19) スコープが狭い名前 9 (20) 意味がとれる名前 9 (21) 無意味な名前 10 (22) 大文字小文字 10 3. ガイドライン 10 (23) コーディングスタイル 10 (24) 長い行 12 (25) 長い宣言行 12 (26) import 13 (27) abstract class vs. interface 13 (28) public variable 14 (29) 初期化 14 (30) static変数を避ける 15 (31) finalを好め 15 (32) private vs. protected 15 (33) get/set メソッド 15 (34) 変数隠し 16 (35) 配列宣言 16 (36) publicメソッド 16 (37) 状態取得と状態変更の分離 16 (38) thisのreturn 17 (39) メソッドの多重定義 17 (40) equals()とhashCode() 17 (41) clone() 18 (42) デフォルトコンストラクタ 18 (43) abstract method in abstract classes 18 (44) オブジェクトの同値比較 19 (45) 宣言と初期化 19 (46) ローカル変数の再利用は悪 20 (47) if/while条件中の “=” 21 (48) 大小比較演算子 21 (49) キャスト 22 (50) 例外クラス 22 (51) メソッド引数の変更は悪 22 (52) メソッド引数の名前 23 (53) toString() 23 (54) switch,if/elseの繰り返しは悪 24 (55) String と基本型との変換 24 (56) コレクション 24 4. コメント 25 (57) javadoc の活用 25 (58) 長いコメント 25 (59) javadocタグ 25 (60) クラスコメント 26 (61) // vs. /* */ 27 5. パフォーマンス 28 (62) まず計測 28 (63) new 28 (64) synchronized 29 6. その他 29 (65) 自分で新しく作る前に相談 29 (66) 複雑な設計は悪 29 (67) パフォーマンス調整は測定後 29 (68) トリッキーなコードは悪 30 (69) 100%正しいことはない 30 7. 参考資料 32 方針 このコーディング標準は，LiCS-XP開発プロジェクトにおいてjavaでコーディングする際のルール，推奨，および迷った時の指針を提供するものである． 標準策定の方針は，読みやすくメンテナンスしやすいコードを書くことである．実際のコーディングにあたっては，プロジェクトメンバー全員がこのルールに合意していることが必要である． 命名規則 パッケージ名 “.” で区切られた文字． JP.jectnamejunit.framework ファイル名 パブリックなクラス名は，コンパイラの規則により，ファイル名と同じでなければならない(大文字小文字の区別を含めて)． クラス名 先頭大文字．あとは区切りを大文字． CapitalizedWithInternalWordsAlsoCapitalized 例外クラス名 最後をExceptionとしたクラス名． ClassNameEndsWithException インターフェイス名 クラス名に同じ．ただし，classと区別の必要があれば，最初にIを付ける． IName