Webドクターコラム
> > コーディングガイドラインについて
Webドクターコラム
お役立ち・知識

コーディングガイドラインについて

image141217

今回はコーディングガイドラインについてお話します。

皆さんはコーディングガイドラインという言葉を聞いたことがあるでしょうか?
プログラマやwebデザイナー、SEなどを経験されたことがある方は、聞いたことや、目にしたことがあるかと思います。簡単に言ってしまうとコーディングガイドラインは、言葉の通りコーディングを行う際の規則・ルールです。
会社で1つのガイドラインを統一されていたり、チームや案件ごとにガイドラインを作成されていたりと、運用方法は様々です。
ガイドラインに記載されている内容は、会社やチーム毎で違いますが、主に「命名規則」「コーディング規則」「禁止事項」「ディレクトリ構造」などが挙げられます。

では、何故このガイドラインが作られているのでしょうか?

ガイドラインを作成する理由としましては、主に「保守性」、「可読性」、「効率化」の3つあります。 まずWebサイト制作者が常に一人だけで運用を続けていくことは、少ないと思われます。
制作者が独特の命名規則・ディレクトリ構造で構築していると、制作者以外の第三者が運用や修正を行う際、サイト構造を理解することに多くの時間を費やす必要がでてきます。更に修正を行った際、CSSが予期せぬ場所にも紐づいており、修正対象の箇所以外でレイアウトが崩れてしまうなどの問題が発生してしまう可能性もあります。
しかし、Webサイト制作者がコーディングガイドラインに基づいて制作を行っていれば、第三者が見たときもサイト構造を理解しやすく修正も行いやすいため、作業工数の削減や品質を一定に保つことができます。

ただし、細かく規約化してしまうと、ガイドラインが膨大な量になってしまい規則を全て記憶しにくいことや、柔軟な対応ができないという問題も発生してきます。
そのため、コーディング規約は誰が見ても分かり易いようにするため、最低限のルール付けのレベルで定めておくのがベストだと感じられます。

現在ではWordpressの導入により、自社でWebサイトを管理されるお客様も多くなっていますので、必要に応じたガイドラインを作成しておくことをおすすめします。