コーディング規約を作る目的とは？規則内容や作るポイントを紹介

コーディング規約を作る目的とは？

コーディング規約とは、プログラミングするときに守るべきルールのことをいいます。コーディング規約を作る目的は、作成したプログラムの品質やメンテナンス性を高めるためです。

コーディング規約が定まっていないと、プログラミング担当者によってプログラムの書き方が異なるため、不具合発生時や改修時などのプログラム解析に時間がかかる可能性が高くなります。

コーディング規約を作る利点

コーディング規約がない状態で、自由にコーディングを行うと、プログラマの個性が反映されたプログラムが出来上がり、ほかのプログラマが読み解くには時間がかかってしまいます。

コーディング規約に則ってプログラミングを行えば、他人が作ったプログラムでも、短時間で読み解きやすいのが利点です。コーディング規約によりプログラミング手順がルール化されていれば、誰でもメンテナンスできるプログラムを作成できます。

コーディング規約を作る欠点

コーディング規約を作成しておけば、品質や保守面でメリットが得られる反面、プログラミングの効率面が低下する等のデメリットとなる点もあります。

コーディング規約をしっかり理解したうえでプログラミングを行わなければならないので、規約を覚える時間と手間が必要であることも欠点といえるでしょう。

コーディング規約を遵守すると、コーディング内容が冗長的になったり、新機能が制限されたりすることもあります。技術の進歩に合わせて、頻繁にコーディング規約の見直しが必要な点も欠点といえるでしょう。

コーディング規約の規則内容9つ

長期的に保守していくプログラムや、プロジェクト内で複数のプログラマがプログラミングを担当していく場合などは、コーディング規約を作成するのが一般的です。実際にコーディング規約を作成するときには、どのような内容を規定していけばよいのでしょう。

ここではコーディング規約に記載すべき内容について解説します。

• 目的についての記載をする
• 禁止事項を決めておく
• 命名規則を決めておく
• 推奨事項や制限事項を決める
• プロジェクトの構成を決める
• プログラミングを作る手順を決める
• リソースの説明と制限を書いておく
• コーディングスタイルを明確にする
• 多人数で作るときの規則を決める

1：目的についての記載をする

コーディング規約の冒頭で「目的」について触れましょう。コーディング規約を守るべきプログラマすべてが、「コーディング規約」を必要とする理由を知っているわけではありません。

コーディング規約を適用する意味・必要性と適用範囲を定義しておきましょう。

2：禁止事項を決めておく

プログラミングで使用してはいけないコードがある場合は、禁止事項としてコーディング規約に記載しておきましょう。

古い文法として残されているだけで、未来を見据えてプログラミングするときには使わない方がよい命令があれば、使用禁止の命令一覧として掲載しておきます。絶対使用禁止ではなく、条件によって使用可能とするなら、例外としてその旨も記載しておくようにしましょう。

ただ「禁止」とするのではなく、禁止理由も記載しておくことで、プログラマもルールが腑に落ちて、遵守しやすくなります。

3：命名規則を決めておく

コーディングでは、クラスやメソッド、変数など、名前をつける場面があります。コーディング中の命名には、プログラマの個性が出やすいため、コーディング規約のなかで「命名規則」として規定しておきます。

命名規則として定義するのは、クラス、メソッド、変数など、命名するものごとの、命名ルールです。大文字から始めるとか、命名しているカテゴリの略称の後ろに機能名を何文字以内で記載するなどが、命名規則となります。

4：推奨事項や制限事項を決める

推奨事項とは、「同じ命令を実現できる関数が複数あったとき、どの関数を使用するか」といった問題や複数の文法で実現できる場合などに、選択したい関数・文法を提示しておくことです。

制限事項では、選択可能な事項であっても、プロジェクトとしては選択しないよう「制限」として規約しておく事項です。

推奨事項と制限事項、いずれも、内容の提示だけでなく、理由も提示してプログラマが納得できるようにしておきましょう。

5：プロジェクトの構成を決める

「プロジェクトの構成」は、コーディングのときに、ソースの冒頭に記載することがあるので、コーディング規約に記載しておけば統一できます。

プロジェクト構成の情報として、プロジェクト名称やメタ情報の指定方法、フォルダ構成などを提示しておきましょう。

6：プログラミングを作る手順を決める

プログラミングを進めていく手順をすべて規定するのは作業が細かく、難しいことです。コーディング規約のなかでは、プログラミング手順のなかでプログラマの個性が出やすい部分をピックアップして規定しておきましょう。

使用するプログラミング言語やフレームワークのバージョンを明記することも大切です。エラー処理のタイミングや、表示するメッセージの文言、画面遷移ルールなど、プログラミング全体を見通して定義しましょう。

7：リソースの説明と制限を書いておく

リソースの利用について特筆すべきことや制限がある場合は、コーディング規約に記載しておきましょう。

エラーメッセージをプログラム内に記載するのではなく、エラーコードを書けばプログラム動作時にエラーメッセージを参照できる仕組みを使うことがあります。

コーディング規約にリソースファイルを参照する仕組みについて記載しておかないと、プログラマはエラーメッセージをすべてコーディングしてしまいます。

8：コーディングスタイルを明確にする

コーディングスタイルとは、プログラミングコードの書き方のことを指します。文法のように技術的な部分ではなく、プログラミングソースを見たときの「見た目」の部分です。

作文を書くときには、「文頭は一字下げ」「段落が変わるときは改行」といったルールがあり、ルールを守って書いた作文は見た目に統一感が生まれます。

コーディングでも、コード記述のときに入れるインデントの文字数やコメントの入れ方をルール化しておけば、読みやすいプログラムの形式になります。

9：多人数で作るときの規則を決める

複数のプログラマが同じプロジェクト内でコーディングする場合は、プログラマが1人だけの場合に比べて、規定しておいた方がよい事項も多くなります。

仕様書やプログラムソースの扱いについて、管理方法を明確にしておかないと、不具合を作りこんでしまったり無駄な作業に時間を費やしたりする可能性が高まります。

仕様書やソースのレビューや、完成品の査閲、バージョン・リビジョン管理などについて、ルール化しておきましょう。

コーディング規約を作るポイント6つ

コーディング規約を作成するときには、コーディングの技術面のほかにも気をつけるべきポイントがあります。ここでは、コーディング規約を作成するときに知っておきたい6つのポイントを解説します。

わかりやすいコーディング規約を作成するために、作成ポイントを理解しておきましょう。

• 使用するフレームワークや言語に合うものを選ぶ
• 理由が確かなものにする
• 例外についても柔軟に対応できるものにする
• 運用時には常時見直しができるものにする
• 作業が簡単にできるものにする
• 世間の流れを積極的に取り入れる

1：使用するフレームワークや言語に合うものを選ぶ

コーディング規約を作成するときは、コーディングに使用するプログラミング言語やフレームワークに合わせる必要があります。既存のコーディング規約を流用しても、使用するプログラミング言語やフレームワークが異なれば、適用できないルールもあるためです。

既存のコーディング規約を参考にする場合でも、まる写しにするのではなく、個々の規約を使用するコーディング環境と照らし合わせてカスタマイズしましょう。

2：理由が確かなものにする

コーディング規約としてルール化しても裏付けがなければ、プログラマに納得してもらえず、規約が無視されてしまうこともあります。

コーディング規約として提示する内容は、きちんと理由付けができるようにし、プログラマが納得したうえで遵守できる内容にしましょう。コーディング規約作成者の思いだけで作成することは避けましょう。

3：例外についても柔軟に対応できるものにする

コーディング規約を決めたからといって、絶対に例外を認めないというのでは、コーディングがうまく進まないこともあります。絶対にコーディング規約を守らなければならないのではなく、事情によって例外を認める柔軟さも必要です。

ただし、コーディング規約を守らないことが通常とならないように、例外を認める手続きについては、定義しておく必要があります。

4：運用時には常時見直しができるものにする

コーディング規約は、発行したら絶対に内容を変えてはいけないというものではありません。プロジェクト参加メンバーのスキルレベルや、プロジェクトの進行状況などによって、臨機応変に見直しをして、ブラッシュアップしていきましょう。

コーディング規約を見直した際は、版数管理を行い、すべてのメンバーに参照すべき版を周知することも大切です。

5：作業が簡単にできるものにする

コーディングの統一を図り、作業の効率性をあげようとしてコーディング規約を定めたにもかかわらず、読み込むのが大変だったり、遵守するために作業が増えたりしては本末転倒です。

コーディング規約を作成するときは、読んで理解しやすく、作業の簡易化を図れるように心がけましょう。

高いスキルのメンバーばかりなら、細かな記載を省けますが、技術力が低い者が含まれるときは、丁寧に手順を説明し、コーディングも簡素化できるように導く必要があります。

6：世間の流れを積極的に取り入れる

プログラミングの技術は日進月歩で変化しています。少し前に成功したプロジェクトのコーディング規約を流用しても、記載されている技術がすでに古くなっている可能性もあります。

古い技術指針をもとにコーディングしてしまうことになるので、最新の技術を取り入れて作成しなければなりません。

過去のコーディング規約を参考にすることは構いませんが、最新技術や世間で主流となっている生産性を高める取り組みなども盛り込むようにしましょう。

コーディング規約を作るときに気を付けること5つ

コーディング規約を作成するときは、作成ポイントを押さえるのと並行し、作成時に注意すべき点にも気を配る必要があります。

ここでは、コーディング規約を作成する際に注意すべき点について解説します。よりよいコーディング規約を作成するために、理解しておきましょう。

• 規約作りはスキルが重要になる
• 規則は簡潔に見やすく作る
• プロジェクトに関わるメンバーに合わせて作る
• バグ検出やテストのしやすさを考える
• 常時改善できるようにしていく

1：規約作りはスキルが重要になる

コーディング規約は、プログラマの指針となるルールなため、技術力の低い人や経験の浅い人では作成できません。経験がありスキルの高い人であっても、他人が理解しやすい説明をできないという人もいるので注意が必要です。

コーディング規約は、コーディング規約を利用した経験が多く、抜け漏れチェックもできる、スキルレベルの高い人が複数集まって作成するとよいでしょう。

2：規則は簡潔に見やすく作る

コーディング規約は、利用者が短時間で理解できるように、簡潔に記述するようにしましょう。簡潔にしすぎて、説明が足りなかったり、利用者が納得できなかったりするのでは、生産効率はあがりません。

コーディング規約で定めるルールは、わかりやすく簡潔に記載し、制限・禁止・推奨事項などは、利用者が納得したうえで取り組めるように理由を明記しておきましょう。

3：プロジェクトに関わるメンバーに合わせて作る

コーディング規約は読み手のスキルレベルを考慮して記載します。スキルの高いプロジェクトメンバーばかりの場合は、コーディング規約に多くの言葉を書かず、箇条書き程度でも内容が伝わります。

スキルの低いメンバーが多い場合は、なるべく手順を省かず、必要事項をすべて記述するようにしましょう。

4：バグ検出やテストのしやすさを考える

プログラム開発において、テスト工程はかなりの工数を要します。コーディング規約の作り方次第では、コーディングだけでなく、テスト工程の効率をあげることも可能です。

テスト工程の工数を削減するために、エラー検出をしやすいコーディングルールやデバッグしやすい命名規則を考えるなど、コーディング後の工程も考えて規約を作成しましょう。

5：常時改善できるようにしていく

コーディング規約は、作成してメンバーに配布したらそれで終わるわけではありません。プロジェクト内でコーディング規約の内容に不満が出たり、コーディング効率が低いと感じられたりした場合は、随時見直して、改善していく必要があります。

コーディング規約を作る目的を知ろう！

コーディング規約には、品質や保守性を高めるという明確な目的がありますが、目的を理解せずに単なるルールとして使用しているプログラマも少なからず存在します。

コーディング規約の目的を理解することで、規約遵守にも前向きに取り組むことができます。プロジェクトの実状に合わないコーディング規約については、意見したり、積極的に見直したりしていくこともできるでしょう。