リソース(ファイル)の命名規則を考える

2019/11/28DEVELOP

アプリ開発で使用するリソース達。そのファイル名は予め、一定のルールを設けておくことで秩序が保てる様になります。今回は業務中に実際に遭遇した「びっくりファイル名」の紹介とその対策です。

全角文字が混ざっている

× T h i s i s a p e n
○ this-is-a-pen

日本語など全角の2バイト文字は避ける。

小文字、大文字が混ざる場合はルールに従う

× BG-Texture
○ bg-texture

一見問題ない様に見えますが

var data = FileSystem.Load("bg-texture") // ※ 実際のファイル名はBG-Textureだったら?

この様にパス指定して読み込もうとした際、大文字・小文字を区別するOSと大文字・小文字を区別しないOS(プラットフォーム)が混ざり合った環境において、一方では読み込めるのに、もう一方では読み込めないなど不具合が発生することがありました。(PS3とXbox360等)不具合に気づき辛いのため何かしらルールを設けておくと幸せになれます。

記号は使わない(大小文字に気づかない)

× combo-far&far
○ combo-far-far

&が入ってるとか始めてみました。far&far ってなんやねん。全く・・・ファー!w

スペースで空けない

× story data 001
○ story-data-001

全角スペースかどうか一目で分からない。

まとめ

毎回考えるのが面倒なのでリストアップしてみました。初歩的なことではありますが、初歩的だからこそどんなプロジェクトでも、確実に誰かが一度はやらかします。少し意識するだけでガラッと改善しますので、小さなことって大事ですよねという、そんなお話でした。

Posted by kazupon