WEBサイト制作の勉強

WEBサイト制作の勉強の為の解説ブログです。

コーディングルールの設定

複数人でコーディング作業を進める場合、共通のルールや約束事を「コーディング規約」として事前に決めておきます。例えば担当者が独自の勝手なルールでコーディング作業を進めてしまうと、その担当者以外の者がコーディング作業する事が出来なくなってしまうため、サイトの「保守性」や「持続性」などを考えると、ルールが必要になってきます。また自身が制作したサイトでも、一度完成させた数年後に改修を行う事も珍しくないので、やはりルールを設定しておく必要があります。
ただ、あまり厳しいルールを設けると、逆に効率が落ちてしまい、結果として守られないルールになってしまうケースがあるので、その辺のバランスを上手くとる必要があります。


コーディング規約を大きく分けると「命名規則」「コーディング規則」「禁止事項」の3つに分類する事が出来ます。

命名規則

「id・class名」や「ファイル名」などをつける時に適当な名前にするのではなく、チームの他の人間が見た時に意味の解る物にする必要があります。

コーディング規則

インデントの付け方やネストのパターン、コメントアウトの方法など、コーディングする際の細かいルールも明文化しておく事で、サイトの「保守性」の高める事が出来ます。

禁止事項

禁止事項の場合も、出来るだけ具体的に挙げる事でサイトの「保守性」や効率を高める事が出来ます。



コーディング規約の実例

企業などが採用している実際のコーディング規約を参考にして見ましょう。コーディング規約やスタイルガイドは公開している企業はいくつかあるので、色々と参考にして見ましょう。

googleのコーディング規約

Google HTML/CSS Style Guide

githubのコーディング規約

github.com