プログラムコードを綺麗に保つための10原則
Onextrapixelより。
10 Principles for Keeping Your Programming Code Clean
主にWebアプリ開発を対象とした記事ですが、通常のプログラミングにも当てはまる内容です。今さらとも言うべき常識的な指摘ではありますが、いま一度確認しておくのも悪くはないと思います。
- コーディングの前にロジックを整理する
- ページの構造を明確にする
- 適切なインデントを使用する
- コードの説明をコメントとして残す
- コメントの乱用を避ける
- 不適切なコメントはかえって混乱させる
- 極端に大きな関数を作らない
- 関数や変数の名前は標準的な命名規則に従う
- 変更を加える場合は慎重に
- 変更の旨はコメントに残す
- 複数言語の無差別な混在は避ける
- インポートを整理する
- CSSファイルをまとめるなど
5番について、不適切なコメントの例として次のようなものが挙げられています。
- 自分に向けたメモ （/* Will finish this later... */）
- 他人に責任を押し付ける （/* John coded this. Ask him. */）
- 漠然とした内容の記述 （/* This is another math function. */）
- コードの塊を（コメントアウトで）消す
また、逆に適切なコメントとしては次のような例が挙げられています。
- コードの詳細を書く （/* Coded by John, November 13th 2010 */）
- メソッドや手続きの機能を詳細に解説する （/* This function validates the login form with the aid of the e-mail check function */）
- 加えた変更について簡潔に記す （/* Added e-mail validation procedure */）
