コラム

ねこ式ファイル&フォルダー命名規則を紹介するぞ!4つのルールと禁則事項を添えて

ねこ式ファイル&フォルダー命名規則を紹介するぞ!4つのルールと禁則事項を添えて

記事のポイント

  • 最適なファイル/フォルダー命名規則を考える!
  • 名前は分かりやすく・見つけやすく・端的に!
  • 命名規則はガチガチに作り込まない!

ファイル名の整理は心の整理…。

ファイル名やフォルダー名には、自分が理解できる明確な命名規則が“絶対”必要です。そういうわけで、私が実際に利用している命名規則を紹介&解説していきます。

二条ねこ

命名規則命名規則命名規則…。ブツブツ……。

砂瀧えり

考えすぎて知恵熱出てるやん!

まの

でも、ファイル名やフォルダー名は自分なりの命名規則を設けておかないと、のちのち事故りますからね。

はじめに

まず最初に伝えておきたいのは、
「ファイル名・フォルダー名をガバガバにしてはいけないぞ!」
ということ。

ガバガバなファイル/フォルダー命名規則の例。ガバガバなファイル/フォルダー命名規則の例。

私は俗にいうコーダー的なことをしているので、命名規則に関しては常にベストな案を考えています。というのも、ファイル名やフォルダー名を場当たり的に命名すると、あとで探せなくなるからです。

命名規則をしっかり整えておくことで、保存ファイルの冗長性(データ重複)を避け、サルベージを容易にすることが可能になります。まぁ、本棚やCD棚を整理するイメージに似ています。

二条ねこ

もち、命名規則を統一させるべきなのは、コーダーに限ったことじゃなくて、万人に言えることだからねー!

ねこ式ファイル&フォルダー命名規則

私のファイル/フォルダー命名規則の例。私のファイル/フォルダー命名規則の例。

ねこ式ファイル&フォルダー命名規則

①_②-③_④

  • ①:No.《番号(0001) or 日付(yyyymmdd形式)》
  • ②:Name《名前(browser, cat...)》
  • ③:Purpose《目的(tmb, logo, box...)》
  • ④:Ver.《版(1, 2 , 3...)》

細かい解説はこれからするとして、私の場合は上記のような命名規則をファイルやフォルダーに設けています。

例えば、

  • foo-logo_1.png
  • 20191231_bar-tmb.jpg
  • 0001_pic

という感じで命名しています。

二条ねこ

いろんな意見があるけど、私はフォルダーの上層と下層とかでルール分けはしてないよー!汎用的な命名規則って感じだねっ。

命名規則と禁則事項

命名規則にはルールを決め、禁則事項を守ることが大事。命名規則にはルールを決め、禁則事項を守ることが大事。

私のファイルやフォルダーの命名規則を見てもらったところで、なぜこのようなルールになったかの説明と、命名規則の禁則事項を話しておきます。

命名規則について

  • 【1】連番や日付は文頭に記載。
  • 【2】半角英数字小文字で記載。
  • 【3】名前や目的はダラダラ書かない。
  • 【4】汎用性を持たすために規則固めしない。

上記の事項を命名規則を設定する上で決めています。

まの

なかなかに細かいですね。

二条ねこ

ルール決めが一番大事だったりするからね〜。

【1】連番や日付は文頭に記載

  • 0001_foo
  • 20191231_bar

のような連番や日付は、“ソート”を意識して文頭に記載しています。

連番は、ファイル管理の観点から4桁数字が妥当(1つのフォルダーに万単位のファイルを入れるとエクスプローラーがハングしやすいため)だと判断し設定。
日付は、バラツキをなくすために『yyyymmdd形式』という記述形式を用いています。

【2】半角英数字小文字で記載

名前に統一感を出すために、すべて半角英数字の小文字で記載するというルールにしています。

これは関数や変数、CSSセレクタを命名する際の『Snake caseスネークケース』と『Kebab caseケバブケース』をベースにした結果、この記述方法がベストと判断したからです。

【3】名前や目的はダラダラ書かない

ファイルやフォルダーは視認性が命なので、名前や目的はダラダラ書かずに端的に書いています。

例えば、
「cat-thumbnail」
と書くところを、
「cat-tmb」
という風に記載しています。

二条ねこ

主題とはズレちゃうけど、普段からCSSセレクタを書くときに長くなるのが嫌だったからこの命名規則使ってたのだ!それをファイル/フォルダー名に逆輸入した感じなんだよね〜。

【4】汎用性を持たすために規則固めしない

ファイルやフォルダーを命名するときに、あまりにもガチガチにしちゃうと例外が出たときに発狂しちゃうので、あくまで大枠のルールだけ守れればOK理論でやってます。

例えば、絶対に日付を入れないといけない…なんてしちゃうと、どうしてもな例外が出たときに命名規則の論理性が崩壊するからです。だったら、最初から守れそうにないルールは作らないってことです。

禁則事項について

個人的に命名規則ではなく、ファイル管理をする上で守っておきたいルール(禁則事項)もあります。

ファイル/フォルダー命名時の禁則事項

  • スペースは入力しない。
  • 『-』と『_』以外の記号は使わない。
  • ひらがな・カタカナ・漢字は使わない。
  • コンピューターが作成したファイル・フォルダーは触らない。

上記の3項目に関しては、WindowsとmacOSを一般的な使い方で扱うなら気にすることではなかったりします。いわゆる“UNIXな話”ということ。ただ、記号に関してはOS側で弾くものもあるので、変な記号は使わないのが懸命です。

また、どうしても命名規則を統一させたいからといって、コンピューターが自動で作成したファイルやフォルダー名を弄らないように。ファイル破損の元です。

まの

だから、命名規則は“ゆるく”なのですね?

二条ねこ

そゆことー!

命名時のヒント

今回紹介したのは、あくまで私の命名規則なのでお好きなように。でもでも、それでは投げやりなので、命名規則を作る上でのヒントになりそうなものを載せておきます。

名称 備考
Upper camel case FooBarBaz 単語先頭大文字
Lower camel case fooBarBaz 初単語以外単語先頭大文字
Snake case foo_bar_baz 小文字+アンダーバー
Kebab case foo-bar-baz 小文字+ハイフン
Train case Foo-Bar-Baz 単語先頭大文字+ハイフン

主な命名規則に使われる記法。

これらは関数や変数を指定するときに使われます。これをファイル名やフォルダー名の命名規則を策定するときにあてがうと便利。もちろん、正解不正解はないのでお好みで。

二条ねこ

これらの記法は、

  • Camel case:Java・JavaScript
  • Snake case:PHP・Python・Ruby
  • Kebab case:HTML・CSS・Lisp

ってイメージで使われる感じかなー。

まとめ「命名規則は例外ありきでゆるく作る」

まとめ「命名規則は例外ありきでゆるく作る」

おそらく命名規則を設けたい人は、性格的に神経質な人なはず。でも、あまりガチガチに作り込むと例外が出たときにバグってきます。なので、命名規則はゆるーく作るのがおすすめ。

最低限の禁則事項さえ守っておけばいいのです。だって、命名規則は人次第だもの。ねこを。

二条ねこ

大事なのは“几帳面さ”と“臨機応変さ”ってことですな〜!

この記事で紹介したガジェット

おまけ

砂瀧えり

「ねこを」って…。

まの

ほんと、意味不明な言葉を投入しないでください。

二条ねこ

えー!?
命名規則って、何だか詩的だと思わない?だから、最後は詩っぽく締めたのになー。

おわり

COMMENT