
186
コーディング規約
コーディング規約は、インデントの幅や括弧の配置位置など、ソース
コードのスタイルについて定めるものです。「インデントはタブ文字だ」
「いや、半角スペース4文字がよい」といった不毛な議論を避けるため
にも、プロジェクトの標準を定めて全員がそれに従うようにします。
コーディング規約を一から作成するのは労力を要するため、組織の標
準や業界の標準的なコーディング規約があればそれを用いましょう。標
準的なコーディング規約を使うと、静的解析ツールやフォーマッター用
の定義ファイルが入手しやすいというメリットもあります。たとえば、
Javaプログラム向けの静的解析ツールとして広く利用されている
Checkstyle
※ 19
の場合、Google Java Style Guide
※ 20
というコードス
タイルに対応した定義ファイルが標準で同梱されています。
コーディング規約は、プログラミング言語単位(例:TypeScriptコー
ディング規約、Javaコーディング規約)か、もしくはテクノロジーのま
とまり単位(例:フロントエンドコーディング規約、バックエンドコー
ディング規約)で作成するとよいでしょう。
命名規約
命名規約は、ソースコードのファイル名や、名前空間名、クラス名、
メソッド名、変数名などのネーミングに一貫性を持たせることを目的と
する規約です。コーディング規約の一部として含める場合もあります。
命名規約では、メソッド名はキャメルケースとする、といった構文論
(シンタックス)に関するルールだけでなく、どう名付けるべきかとい ...