エンジニアブログ

エンジニアブログ
MT技術情報

XHTMLとCSSのコーディングガイドライン

小林 2008年10月03日

スカイアーク社内にはXHTMLとCSSのコーディングガイドラインがあります。MTは特にHTMLに触れる機会が多いので、全員が同じ品質でHTMLを書くためには必要になります。

このガイドラインの特徴は以下です。

  • ガイドラインを順守すればCSSハックなどを使わなくてもモダンブラウザに対応できる(バグ回避がガイドラインになっている)
  • ID・Class名のつけ方はあらかじめ決まっているので、名前を考える手間が省ける
  • HTMLのソースコード量を削減できる(ただ、ページ数が多くなる場合、CSSが肥大化してClass管理が大変になるデメリットもあります)

参考までに2ページほどお見せします。ここ間違ってるよ、などのアドバイスがありましたらトラックバックいただければ幸いです。
(印刷の関係でセルが途切れていますね・・・あくまで参考なのでそのまま公開しました笑)

スカイアークのコーディングガイドラインの一部(参考までに)

この他にもID・Class名ガイドライン、ファイル名ガイドラインがあります。たとえばガイドラインには、

  • 注釈=note
  • パンくずリスト=topicPath
  • ~の詳細=detail

など、言葉とclass名がセットになって記載されています。

私たちのガイドラインはまだまだ改善の余地がありますが、大切なのはプロジェクト後に反省を行って、苦労したことや良かったことなどをガイドラインにアップデートしていくことですね。私たちも実務に追われてそのようなことが忘れがちになることがあるので、自戒の意味も込めてここに書きました。

参考になれば幸いです。