コーディングのルールを明文化してチーム作業を効率化！ 『コーディング規約』作成の目的・メリット・作成方法を解説

スポーツの世界では、アスリートはさまざまな困難を乗り越えトップを目指し戦っています。競技はさまざまありますが、どんな競技でもルールが存在し、それが戦いのスパイスとなり競技の個性や面白さになっています。

コーディングに関しても、HTMLやCSSなどには記述の基本ルールがあり、それに則って作成したものがブラウザで認識でき、ページとして表示されます。ただ細かい部分を見ると、組み方や命名方法が個人のスキルに委ねられ、他の人から見ると難解なソースになってしまうこともあります。そこで必要となってくるのが、「コーディング規約」です。チームで円滑に作業を進めるため、またクライアント側との認識を合わせる意味でも、最低限のルール決めておくことが重要です。今回は「コーディング規約」について、その重要性と、どんなことを決めたら良いのかを考えていきます。

作成する目的

「コーディング規約」を作成する目的は、作業の効率化と品質を確保することです。作業者がそれぞれの方法で制作してしまうと、ソースごとに見方が変わってしまい、他の人が見ると判りづらいことがあります。その結果、ソースコードのエラーを見過ごしてしまい、トラブルに発展する恐れがあります。またメンテナンスの際にコードを理解する時間がかかり、余計な工数を割かなければならなくなります。ルールを作成することで、これらマイナス要因を減らし、効率的に進めることが可能になります。

コーディング規約のメリット／デメリット

「作成する目的」で述べたように、コーディング規約を作成することで、いくつかのメリットが生まれます。ここまでを見るといいことずくめのようですが、もちろん作成することでデメリットも存在します。メリット／デメリットを理解した上で、コーディング規約を作成するようにしましょう。

メリット	品質の担保 コードの属人化を防ぐ 可読性を高め保守を容易にする
デメリット	技術使用範囲を限定してしまう 新しい技術導入が容易ではなくなる

コードは人が作成するものなので、ルールが存在しなければ作成する人のスキルに委ねられてしまいます。品質を一定に保つためにルールは必要ですが、その一方、決め過ぎてしまうことで柔軟に対応できなくなる恐れがあります。
例えば、既存のルールに則ってコーディングしたものが、新しい手法でコーディングしたものと比較してコードやスタイル定義に無駄が多く生じることが考えられます。実現する方法がいくつかある場合、スキルの高い制作者であればベストな方法でコーディングすることを望みますが、ルールがあるため使用できず、ストレスを抱きながら作業を行わなければなりません。
また、新しい手法を導入したとしても、ルールが二重化して混乱を引き起こしたり、メンバーへの周知が必要になったりするなど、制作作業以外の対応も必要になります。
メンバーのスキルやサイトの特性に合わせて、メリット／デメリットのバランスを考慮し、ルール作りができると良いでしょう。

コーディング規約の記述内容

ルールの記載内容については、DDSで実際に作成しているコーディング規約も参考に、必要な項目をピックアップしてみました。

目的

ルールを作成することでのメリットや適用範囲などを記載する。

推奨環境

ターゲットとなるブラウザや動作環境などを記載する。

構成要素

ソース内に記載するメタ情報やサイトのフォルダ構成などを記載する。

命名規則

ファイル名（HTML、CSS、JS、imageなど）、id名、class名の付け方を記載する。
（例）キャメルケース、スネークケースなど

コーディングスタイル

文字コード、改行コード、インデントの単位、コメントの書き方、CSS設計思想などを記載する。

制限事項

使用するライブラリやフレームワークのバージョン情報、使用ツールや推奨しないコーディング方法などを記載する。

その他補足

サイトの特性や環境依存による例外、上記項目で補足するものがあればこちらに記載する。

作成時の注意点

コーディング規約は、制作の効率化やメンテナンスをしやすくするためのもので、ルール作りをすることが目的ではありません。本来の目的を見失わないために、以下の点を考慮して作成することが大切です。

わかりやすく使いやすく

専門用語を多用しないことや複雑な構成を避け、読み手が理解しやすい記述を心がけましょう。また制作時に迷いや悩み事が発生しないよう、予想されるパターンを想像して作成するようにしましょう。

クオリティ確認のしやすさ

制作者によってスキルはさまざまですが、ルールを決めることでクオリティは保てます。また、確認作業の際に、ルールに沿って確認することでルール違反やバグなどを見つけやすくします。

例外対応の柔軟性

時間の経過とともに新しい技術が生まれたり、これまでのルールに当てはらないものが生まれたりすることが予想できます。このようなときは無理矢理ルールに当てはめようとしても限界があるので、ある程度の柔軟性も必要です。例外が起きたときにどのように対応したら良いのか、必要最低限の決まりも作っておくと良いでしょう。

これらの注意点を考えてみると、WEBについての深い理解と、現場を想像する力が必要なことがわかります。ルールを決めるときは、個人の知識だけではなく経験豊富な人の意見を取り入れ、複数の視点で作成することが望ましいです。

実際の現場では

DDSでは、新規で制作にとりかかる場合、必ず「コーディング規約」を作成しています。また、既存サイトの運用・更新依頼の場合にも「コーディング規約」を確認し、ルールに沿って作業するようにしています。しかし、長い期間継続して運用しているサイトの中には、「コーディング規約」を作成していない場合もあります。その場合は、既存の作成方法にこだわらず最新の手法を取り入れても良いかと思います。変更した際は、その手法や対象ブラウザなどの情報を共有できるようにドキュメント化すると良いです。また、新しいものを取り入れる際は、運用メンバーのスキルに合わせて決めることが重要です。難易度が上がると効率が悪くなることもあるので、バランスを考えて設定するようにします。

まとめ

コーディング規約を作成することにより、品質の担保や制作のしやすさだけではなく、使い方によってはメンバーのスキルアップにも貢献することでしょう。また、クライアントのコンセンサスを得るのにも重要な資料となります。ルールを尊重することにより安定した運用に繋がり、その結果クライアントの信頼を得ることができると思います。
ルール作りの難しさはありますが、多くのメリットを生み出すものになるので、クライアントと制作側が共に幸せになるよう、最適な方法を提案できるようにしていきましょう。

株式会社デジタルスケープ
デザイン&デベロップメントスタジオ
高杉 充

2005年よりWEB業界に入り、未経験ながらOJTで１年ほど数社のサイト更新を経験した後、以降はグローバルメーカーやWEB証券会社のサイト運用など大手から中小企業まで様々な案件にWEBコーダー・フロントエンドエンジニアとして携わる。現在は、フロントエンドエンジニア・ディレクターとして、サイトリニューアルやお客様先常駐案件などの提案から制作・運用までを担当。
コミュニケーションを通して信頼関係を構築し、安心して働ける環境でメンバーと共に成長することが何よりの喜びです。