個人的なディレクトリ・ファイルの命名規則
個人的に決めている、ディレクトリ（フォルダ）やファイルの命名規則です。
割とこういう記事は見つからなかったので、書いてみました。
前提
- ディレクトリとフォルダは同意義
- 全てこの規則に合わせてず、状況に応じて変更する
共通事項
言語を統一する
日本語ファイルなら日本語、英語なら英語と、基本的には言語が混ざらないようにしています。
以下がサンプルです。
日本語
英語
無理に英語にしようとしない
ローマ字表記（kakunin, kakeibo などの日本語をローマ字に直した表記）です。
過去、全て英語にすることで、カッコいいと思っていました
しかし、可読性が低く、毎度翻訳をする必要があり、無駄と思えたので断念しました。
既に規則がある場合は、存在する規則に合わせる
大切なことは、最善（オレオレ）な命名規則ではなく一貫性があることです。
なので、既に規則があれば、そちらに合わせます。
例えば、仕事でルールが決まっていたり、プログラミング言語仕様で決まっている場合は、既に存在する規則を優先させます。
ディレクトリ（フォルダ）
命名規則
ハイフン区切りで命名します。
例えば、my-test-toolやtest-apiなどのような表記です。
命名方法
以下の順を考慮して命名しています。
- プロジェクト名（プロダクト名）があれば、プロジェクト名をつける
- プレフィックスをつけ、以降はディレクトリの目的を記載する
- 個人的なもの ...
my- - 家庭（家族）のもの ...
familier- - 特定のプログラミング言語 ...
python-
特に、my-をつけるのは個人的にも定着しているので、オススメです。
作成タイミング
- プロジェクトを始める時
- ファイルが複数でき、ある程度グループ化できるようになった時 いきなりディレクトリを作るのではなく、まとまりができてから作成しています。
気をつけていること
実際は、プロジェクト名とプロジェクトの中のディレクトリで微妙に変えています。
- プロジェクト名 ... 何をするのか分かるように書く（
my-tweet-analisis） - プロジェクト内のディレクトリ名 ... 可能な限り一単語で（
api/document/test）
ファイル
命名規則
アンダースコア区切りで命名。
例えば、test_document.txtのような形です。
命名方法
- git管理していれば、目的の名前にする 日付などをつけて、同じファイルを複数もたない（バックアップをしない）
- 日付を含める場合は、yyyymmdd形式で（
20190101のような形） - 日時まで含める場合は、yyyymmddHHMMSS形式で（
20190101120101のような形）
未決事項
日付を付ける際、前につけるか、後ろにつけるかは、決めきれていません。
過去に試したこと
以下は過去に使っていたが、良くなかったので辞めたことです。
プレフィックスに数字をつける
- 01xxxx
- 02yyyy
のように命名していましたが、
- ディレクトリを消す時に空き番号ができ、気になる
- 数字に意味を持たせてしまい、暗黙のルールを作ってしまう
ことがあり、辞めました。
先にディレクトリを作っておく
先に、必要になりそうなディレクトリを作成し、ファイルを作るたびに配置する方法です。
一番初めに体系立てて作れるので、気持ち良いのですが、結局使わないディレクトリがでたり、構成が異なることがあるので、やめました。
その他
my-とかの規則にしておくと、googleドライブで検索するとき、結構楽なのでオススメです。
他に、こういうのやっているとかあれば是非教えてください。
この資料は随時更新を予定しています。
