名づけルール・・・BEMについても少々

ファイル名やフォルダ名、class名、id名、変数名、関数名・・・など、コーディングするときに、自分で名前を付けなければならない場面が多々あります。
基本的にはわかりやすい名前であるのがよいですが、長すぎても扱いづらいし、深く考えている時間もないし・・・ということで、画像ファイルならimg1.jpgなど、安易に名前＋連番という形式にしてしまいがちです（それがダメだということではないです）。
さらに1ページに対して複数の人が更新をかけていたりすると、英語表記とローマ字表記が混在していたり、なんだかカオス状態になるわけです。
そこで名づけルールについて少し触れます。

名づけルールがなんとなくでも決まっていないと、あとでファイルを整理したり、何かしらの変更作業をする際に、作業が煩雑になったりして、管理上こまることがあります（ただし、何らかの理由でわざと名前を推測できないようなランダムなテキストの羅列による名前を利用する企業もあります）。

もちろん、個人のwebページであればあなたの、自社のwebページであれば自社の、クライアント企業のwebページであれば所属している制作会社とそのクライアント独自の名づけルールが存在するでしょうから、それを優先してください。

ここでは独自の名づけルールを考える前に、前提となる注意点や一般的な命名規則について説明します。

とはいえ、これまで特に問題が起こっていないなのであれば、既存の名前を変える必要はないし、今後もあんまり意識しなくてよいです。
他社に移籍したりして誰かに指摘されても、あわてたりムカついたりしなくてもよくなる程度に目を通してください。

ファイル名・フォルダ名の名づけルール

基本、WindowsとかOSの皆さんに怒られないように名前を付ければいいのですが、web制作をする上で気を付けたい名づけルールがいくつかあります。

ベタなところでいうと

という感じですかね・・・

実は、これら以外にも名づけで気を付けたいことがあります。

実際、これでトラブルになることは（web制作では）滅多にないです。
ただ、サーバによくつかわれるUNIX系のOSでは数字のみもしくは数字から始まるファイル名の指定の時とかいろいろあるので、あんまり使ってほしくないなー的な感じだったりします（プログラマ歴長い人だと、生理的に受け付けないってゆー人もいます）。
なんとなく、こういうこともあるんだなー程度に覚えておいてください。

ファイル（フォルダ）名が数値から始まっていたり、数字のみであったとしても、数字ではなく文字列として認識されるようなので、神経質になる必要はないです。
うっすら記憶にとどめておいて、誰かに何か言われたら「あーそーゆーことかなー」とか思っていただければよいかと。

ただし、javaではファイル名が数値から始まるファイル名はNGのようです（ファイル名としてはアリなのだけれど場合によってはうまくないようです）。
HTMLのコーダーがjavaファイルを扱うことはあまりないと思いますが、一応、念のため。

class名やid名、変数名、関数名等の名づけルール

だいたいファイル名の名づけルールと同じです。

ファイル（フォルダ）名での名づけルールではなんとなくで良いとした数字のみもしくは数字から始まる名前ですが、class（id）名では絶対に使わないでください。
数字のみもしくは数字から始まる名前で始まるclass名は認識されないです（OS、ブラウザ、各バージョンにもよるかも）。

htmlコーダーと開発担当（webページにphpやらperlやらを組み込む人たち）が同じ部署にいないなど、密にコミュニケーションが取れない状態（しかもそれらの開発コードがhtmlコーダーには見えない状況）だと、開発担当者が入れたい（入れていた）id名やらclass名やらとhtmlコーダーが使うid名やらclass名やらが重複して、webページがうまく動作しなくなってしまったりすることがあります（重複しても問題ないこともあります）。
そういうことが発生しないように名づけルールを作っておけば、ある程度回避ができます。
それでも、こういった問題はまれに発生するので、なにか問題が発生したら、原因の候補として心にとどめておくとよいかもしれません。

独自の名づけルールを作る

上記のような、基礎となる名づけルールを踏まえて、状況・環境に合った独自のルールを作ってみてください。
たとえば、以下のようなことを決めます。

などといった具合にルールを作っていきます。
作るwebページが特定の企業のものであれば、会社紹介で使う画像ファイルには先頭にcorpをつけること・・・などのようなルールがあったりします。

しかし、ある程度ルールが決まっていても、とっさになんと命名しようかと悩みますよね。
たとえば何のためのclassなのかわかりやすい名前にはしたいけれど、長ったらしい名前にしてしまうのも不便だし、かといって省略しすぎてしまうと、他の人に伝わりにくい・・・
そもそもボキャブラリーが少ない・・・
といった問題。
そこで悩みすぎて命名に時間をかけすぎてしまうのもアホらしけど、あんまりいい加減な名前を付けるのも・・・
といったときは以下を参考にしてみてください。

個人的にはエディタやブラウザの検索機能とか使えば、簡単に把握できるから、あんまりルールに縛られなくても良いのではないかなーと思ったりもしますが、そういうツールを使い慣れた人ばかりではないし、好みの問題は意外と根深かったりするので、適当にルールにしばられてあげるのもやさしさなのではないかなーとも思ったりもします。
複数人で制作する際にある程度名づけルールを統一しておくと、中途採用で入ってきた人とかが更新する際にも状況が把握しやすくなったり、管理が容易になるメリットもあります。

ただし、あまり細かいルールを設けると、おぼえるのがたいへんなので、ほどほどにしましょう。

戻る

Top