コーディングルール - Developer's Note@Wiki

コーディングルール

はじめに

目的

プロジェクト開発においてコーディングルールに沿って開発を進めていくことは、非常に重要である。その理由は以下の通りである。

1. 本人だけでなく他人のもわかりやすいコードとなる。
2. 開発スピードが高められる。
3. バグの発生を未然に防ぐことができる。
4. バグ発生時も素早い対応ができる可能性が高くなる。

本コーディングルールは基本的なルールと有効的なルールをまとめたものである。必ずしもこのルールに沿って開発をする必要はない。プロジェクト開発においてJavaでコーディングする際のルール、推奨、および迷った時の指針を提供するものである。

心得

• わかりやすいコードを意識する(他人の視線を意識する)。
  • Javadocやコメントをきちんと書く。
  • 適切にインデントする。
  • 複数のコーディングがある場合、実行速度に差があまりなけれ-ば、わかりやすいコーディングを選択する。
• 同じコードは2度書かない。
  • 修正が生じた場合、2箇所変更しなければならず、バグの原因になる可能性が高いから。
• わかりやすいネーミングをつける。
  • 全て英語で表記し、長くても名前だけである程度推測できるネーミングが良い。

良いコードの特徴(実践J2EEシステムデザイン第4章より)

1. 良いコードは、大幅な変更そ行わずに拡張でき、ばらばらにしなくても簡単に機能を追加できる。
2. 良いコードは、読みやすく、保守しやすい。
3. 良いコードにはきちんとしたドキュメントがある。
4. 良いコードを基にして悪いコードを書くのは難しい。
5. 良いコードはテストしやすい。
6. 良いコードはデバッグしやすい。
7. 良いコードには重複するコードがない。
8. 良いコードは再利用される。

• 基本ルール
  • 命名規約
  • フォーマットスタイル
  • コーディング
  • 設計

#ref_list