コーディングで意識していること

システム開発におけるコーディングで意識していることを洗い出しました。
以下を意識するだけでシステム品質や改修のし易さが向上するはずです。

1．メソッド名・変数名に抽象的な名前をつけない

• メソッド名：DBから会員情報を取得する処理の場合

  • ×：dataget

  • ○：getCustomerData（動詞 + 名詞を意識）

• 変数名：DBから取得した会員情報を格納する変数の場合

  • ×：data

  • ○：customerData

2．メソッド名と処理の内容を一致させる

• updateCustomerDataというメソッド名であれば会員更新の処理だけを記述すること

• 更新用データの加工や更新とは別に登録処理を行いたいのであれば別メソッドに記述すること

3．１つのメソッドの処理は20行以内を目安にする

• 処理の記述が20行を超えそうであればメソッドを分割すること

4．if文やfor文のネストは2つまでにする

• if文やfor文を単体で使用した場合も組み合わせて使った場合もネストは2つまでを意識すること

• ネスト2つを超えそうであれば処理分割や処理内容の見直しを検討すること

5．早期リターンを意識する

• 例えばメソッドの引数の値がfalseの場合にメソッド内の処理を行う必要がないのであれば、処理の冒頭で引数の判定処理を記述すること

6．フィールド変数を乱用しない

• フィールド変数を乱用すると処理の流れを追った時にどこで値が変化したのか分かりづらくなる

• 基本的にはフィールド変数は乱用せず、メソッド引数で完結させていくこと