コーディング規約やコードレビューで注意する点

質問

コーディング規約やコードレビューで注意する点を挙げてください。

解答

コーディング規約やコードレビューで注意すべき点は、**可読性・保守性・一貫性・バグ防止**を意識することが基本です。 以下に重要なポイントを分類してまとめます。 ## ◆ コーディング規約で注意する点 ### 1. **命名規則（Naming Convention）** 変数・関数・クラスなどの名前は**意味がわかる**ように キャメルケース（`camelCase`）、スネークケース（`snake_case`）の**使い分けを統一** グローバル変数、定数などは命名ルールを区別（例：`MAX_RETRY`） ### 2. **インデントと空白** インデントの統一（スペース or タブ、幅は2 or 4） 関数間・ブロック内の空行を**読みやすさ重視で使う** ### 3. **コメントの使い方** **なぜそのコードがあるのか**を書く（How より Why） 不要なコメント（昔のコード、デッドコードの説明など）は削除 ### 4. **エラーハンドリング** 例外処理（`try-catch`など）は明確に エラーを握りつぶさない、ログを残す ### 5. **関数やクラスの責任範囲** 関数は1つの責任（単一責任の原則） クラスも役割が明確になるように設計 ## ◆ コードレビューで見るべきポイント ### 1. **ロジックの正しさ** 要件どおりに動作するか？ バグやヌルポ、境界値処理、例外などは考慮されているか？ ### 2. **読みやすさ** 他の人が読んで理解しやすいコードか？ 変数名や処理の流れが自然か？ ### 3. **冗長な処理・重複** 同じような処理が何度も書かれていないか 共通関数にできないか？ ### 4. **再利用性と拡張性** 変更に強いか？直すときに1か所で済む設計か？ ### 5. **セキュリティやパフォーマンス** SQLインジェクションやXSSなどのリスクはないか 重い処理がループに入っていないか ### 6. **テストしやすいか** 関数がテストしやすい単位になっているか モックで分離可能か？ ## ◆ 補足：レビュー時のコミュニケーション **否定ではなく提案として伝える（例：こうするともっと良くなりそう）** **レビュアーも学ぶ姿勢で**。 レビューは一方通行ではない **スタイルよりも設計や意図を重視**（フォーマッターで解決できることは自動化）

書くのがしんどい 「人生が変わる」これからの文章教室 [ 竹村 俊助 ] 価格:1650円 (2025/4/17 19:46時点) 感想(5件)

文学理論講義 新しいスタンダード [ ピーター・バリー ] 価格:4400円 (2024/3/17 00:16時点) 感想(0件)

にほんブログ村

人気ブログランキング

【下記、広告です。クリックいただけると励みになります。】