Powered by
SmartDoc
頑健なJavaプログラムの書き方
>>
頑健なJavaプログラムの書き方
The AmbySoft Inc. Coding Standards for Java v17.01d
Thu Jun 14 21:11:55 JST 2007
著:Scott W. Ambler
訳：高橋徹
この文書は、Scott W. Ambler氏によって記述された
Writing Robust Java Code - The AmbySoft Inc. Coding Standards for Java v17.01d(2000.1.15)
を訳出したものです。Writing Robust Java Codeは、Java言語のコーディングに関する標準、指針をまとめた文書です。翻訳に関する誤り・ご指摘等ありましたら、訳者へ連絡いただけると幸いです。(訳者：高橋徹email:torutk@alles.or.jp)
目次
序章
はじめに
この文書の目的
この文書の重要な特色
対象とする読者
この標準をよりよくする助力の要請
謝辞
翻訳にあたっての謝辞
本文
1 一般概念
1.1 なぜコーディング標準が重要なのか
1.2 最優先規範
1.3 よい命名がもたらすもの
1.4 よいドキュメントの仕方
1.4.1 3種類のJavaコメントの使い分け
1.4.2 javadocの概要
1.5 Amblerの標準の法則
2 メソッドに関する標準
2.1 メソッドの命名
2.1.1 アクセッサ・メソッドの命名
2.1.1.1 読み出しメソッド(Getter)
2.1.1.2 設定メソッド(Setter)
2.1.1.3 コンストラクタ
2.2 メソッドの可視性
2.3 メソッドのドキュメント
2.3.1 メソッドの先頭に書くコメント
2.3.2 メソッドのコード中に書くコメント
2.4 クリーンなコードを書く技術
2.4.1 コードにドキュメントを書く
2.4.2 コードを段落化する
2.4.3 段落と複数行の命令
2.4.4 空白を使用する
2.4.5 30秒ルールに従う
2.4.6 簡潔に、一行にはひとつのコマンドを書く
2.4.7 演算の順番を定義する
2.5 Javaコーディングのこつ
2.5.1 意味的にコードを構成する
2.5.2 定数を比較文の左側に置く
3 フィールド(属性/プロパティ)標準
3.1 フィールドの命名
3.1.1 フィールドの命名には完全な英語記述を使う
3.1.1.1 別な命名-ハンガリアン記法
3.1.1.2 別な命名-先頭または末尾のアンダースコア
3.1.2 コンポーネント(ウィジェット)の命名
3.1.2.1 別なコンポーネント命名-ハンガリアン記法
3.1.2.2 別なコンポーネント命名-接尾詞ハンガリアン記法
3.1.3 定数の命名
3.1.4 集合（コレクション）の命名
3.1.4.1 別な集合の命名-'Some'アプローチ
3.1.5 名前を隠蔽しない
3.2 フィールドの可視性
3.3 フィールドのドキュメント
3.4 アクセッサメソッドの使用
3.4.1 アクセッサメソッドの命名
3.4.2 アクセッサ・メソッドの応用技術
3.4.2.1 フィールドの怠惰な初期化（Lazy Initialization）
3.4.2.2 定数へのアクセス
3.4.2.3 集合へのアクセス
3.4.2.4 複数のフィールドへの連続アクセス
3.4.3 アクセッサの可視性
3.4.4 アクセッサを使う理由
3.4.5 アクセッサを使わない理由
3.5 静的フィールドは常に初期化する
4 ローカル変数標準
4.1 ローカル変数の命名
4.1.1 ストリームの命名
4.1.2 ループカウンタの命名
4.1.3 例外オブジェクトの命名
4.1.4 ローカル変数命名の悪しき考え
4.2 ローカル変数の宣言とドキュメント
4.2.1 宣言についての一般的な注意点
5 メソッドのパラメータ(引数)標準
5.1 パラメータの命名
5.1.1 代替案-'a'や'an'を接頭辞とするパラメータ名
5.1.2 代替案-型に基づくパラメータ名
5.1.3 代替案-対応するフィールド(があれば)と同じパラメータ名
5.2 パラメータのドキュメント
6 クラス・インタフェース・パッケージ・コンパイル単位に関する標準
6.1 クラス標準
6.1.1 クラス可視性
6.1.2 クラス命名
6.1.3 クラスドキュメント
6.1.4 クラスの宣言
6.1.4.1 finalキーワードを注意深く適用する
6.1.4.2 メソッドとフィールドの順序
6.1.5 PublicとProtectedなインタフェースを最小限にする
6.2 インタフェース標準
6.2.1 インタフェースの命名
6.2.1.1 代替案
6.2.2 インタフェースのドキュメント
6.3 パッケージ標準
6.3.1 パッケージの命名
6.3.2 パッケージのドキュメント
6.4 コンパイル単位標準
6.4.1 コンパイル単位の命名
6.4.2 コンパイル単位のドキュメント
7 さまざまな標準、考え
7.1 再利用
7.2 クラスのimportにワイルドカードを使う
7.2.1 代替案-明示的にimportするクラス名を指定
7.3 Javaコードの最適化
7.4 Javaのテストハーネスを記述
8 成功の秘訣
8.1 効果的な標準の用い方
8.2 コードを成功へ導く他の要素
9 メソッドに関して提案するjavadocタグ
10 これから先はどこへ
10.1 あなた自身の会社内の指針を作成する
10.1.1 このPDFファイルを使う
10.1.2 このファイルのソース文書を入手する
11 まとめ
11.1 Java命名規約
11.1.1 一般概念
11.2 Javaドキュメント規約
11.2.1 一般概念
11.2.2 Javaコメント種類
11.2.3 何をドキュメントするか
11.3 Javaコーディング規約(全般)
用語
12 著者について
参考文献
頑健なJavaプログラムの書き方
>>