お知らせ

コーディング規則を設定する理由

MSDN ライブラリ Visual Studio 6.0

一貫性のあるコーディング規則を採用する主な理由は、アプリケーションの構造とコーディング スタイルを標準化することにより、コードを簡単に理解できるようにすることです。

適切なコーディング規則を使用すると、正確で読みやすく、あいまいな部分のないソース コードになります。ほかの言語規則との一貫性を持たせることができ、直観的にもわかりやすくなります。

最小限のコーディング規則

汎用的なコーディング規則では、最小限の必要条件を規定します。これは、これまでに説明した目的を達成し、同時にプログラマがプログラムのロジックや機能フローを自由に作成できるようにするためです。

読んで理解しやすいプログラムを作成することが目的であり、過剰な制約や不要な制限項目を設けてプログラマ本来の創造性を押さえつけないようにすることが大切です。

最後に、この章で推奨する基準は、簡潔な参考程度のものです。すべてのオブジェクトやコントロールについて規定しているわけではありません。また、役に立つコメントのすべてのタイプについて規定しているわけでもありません。プロジェクトや組織独自の要件に応じて、次の要素を基準に付け加えます。

  • 社内で開発された、またはほかの開発元から購入した、特殊なオブジェクトやコンポーネントの名前付け基準

  • 組織の事業内容や施設を表す変数名

  • プロジェクトや会社にとって、わかりやすさや読みやすさが重要と考えられる要素

参考   プロシージャ、変数、および定数の名前付けの制約については、「プログラミングの基礎」の「コーディングの基礎」を参照してください。

コメント