Javaチェックリスト - ミチシルベ @ wiki

チェックリスト

進捗管理チェックリスト

設計時チェックリスト

製造時チェックリスト

わかりやすいか

• クラス名がわかりやすい名称になっているか。
• メソッド名がわかりやすい名称になっているか。
• 変数名がわかりやすい名称になっているか。
• わかりやすいコメントがつけられているか。

⇒処理内容が名称だけで想像できるものが良い名称。
　この場合はコメントを残す必要はない。

• メソッド内でいろいろな処理を実行していないか。
• レイアウト（インデント）があっているか。

安全か

• 入力されたり、送信された値を変更していないか。
• 不正なデータを考慮しているか。

冗長でないか

• 必要なデータのみ引き渡しているか。
• 使用されていない引数がないか。

参考：コードコンプリート　(著)スティーブマコネル　(出)アスキー出版局

リファクタリングチェックリスト

参考：Java言語で学ぶ　リファクタリング入門　(著)結城浩　(出)ソフトバンククリエイティブ

シンボリック定数によるマジックナンバーの置き換え

【問題】

• マジックナンバーは意味がわかりにくい
• マジックナンバーは複数個所に書いてあると、どんな意味で使われているかを全て調査しなくてはいけないため、変更しにくい

【解法】

1. シンボリック定数を宣言する
2. マジックナンバーをシンボリック定数に置き換える
3. そのシンボリック定数に依存する別のマジックナンバーを探し、シンボリック定数を使った式に変換する
4. コンパイルする

【注意】
ループのカウンタや自明な値は、シンボリック定数にする必要はない

制御フラグの削除

【問題】

• 処理の流れが制御フラグでコントロールされており、コードが複雑になっている

【解法】

1. 制御フラグでコントロールされているループを見つける
2. 制御フラグへの代入をbreakやcontinueで置き換える
3. コンパイルする
4. returnを使用し、制御フラグを置き換える

アサーションの導入

【問題】

• この「この条件が成り立つ」と書いても、プログラム中にチェックされない

【解法】

1. ソース中で成り立つ条件を見つけ出す
2. その条件を含むアサーションを書く
3. コメントが意味を持たなくなれば削除する
4. コンパイルする

【注意】
アサーションを有効にするためには、javaコマンドで-eaオプションが必要
java　-ea　main

ここまで。