変数への命名規則が定まらず、悩んでいます。

Question

以前このサイトで、関数や変数への命名の規則は一貫させた方がよいのかという質問をし、「命名規則」をしっかりさせる大切さを教わりました。

そこで、自身のコードにも命名規則を定めようと考えたのですが、考えれば考えるほど「良い命名規則」がわからなくなってしまいました。

例えば、SQLで、「POSTされたメールアドレスを元に、hogeテーブルからuserIDをSELECTした値」を変数に格納し、それにネーミングするものとします。

// １．変数を見て、どんな条件でどのテーブルから取得してきたかわかるようにする。
$userID_from_hoge_table_by_email = POSTされたメールアドレスを元に、hogeテーブルからuserIDをSELECTするSQL文;

// ２．シンプル
$userID = POSTされたメールアドレスを元に、hogeテーブルからuserIDをSELECTするSQL文;

今まで、２のシンプルなパターンで命名することが多かったのですが、上記の例なら、「あれ、この$userIDってどんなふうに取得してきたデータが格納されているんだっけ？？」と思うことがあり、そうなることを予防するために、たまに１のパターンでコードを書いているときがありました。
結果、コードに長い変数名と短い変数名が混同して、気持ちが落ち着きません。

シンプルかつ、後で見たときに変数の中身がわかりやすい書き方で、悩んでいます。

上記のようなSQL文に対する命名を考えるとき、皆さまの、おすすめの命名規則があればぜひご紹介いただけましたら幸いです。

何卒、宜しくお願い致します。

Answer 1

$userID_from_hoge_table_by_email = POSTされたメールアドレスを元に、hogeテーブルからuserIDをSELECTするSQL文;

長ったらし過ぎて総スカンを食いそうです。
プログラム中のコメントや仕様書として記述すべき内容までネーミングでカバーするのは無理な話です。
hoge以外のテーブルからemail以外の方法で取得するデータも同じカラムに入ってくる様な変更が入ったら、カラム名を直せますか？

データベースの種類、バージョン、使っている言語を明示した方が適切なコメントが付きやすいです。
Oracle12c以降ですとカラム名を128バイトまで使えますが、Oracle11g以下ですとカラム名は30バイトまでです。

OracleですとCOMMENT ON COLUMN(SQL言語リファレンスを見てね)でカラムの説明を付けて、 USER_TAB_COLUMNSとUSER_COL_COMMENTS(リファレンス マニュアル参照)から簡単なテーブル定義書を作成する類のことはよくあることです。

Comments

[yayak]

> プログラム中のコメントや仕様書として記述すべき内容までネーミングでカバーするのは無理な話です。
変に長い命名をしてしまっていた部分を、この機会にやめていこうと思います。
現場視点のアドバイスを頂けて、本当にためになりました。有難うございます。

> データベースの種類、バージョン、使っている言語を明示した方が適切なコメントが付きやすいです。
質問の仕方に関するアドバイスも有難うございます。今後気を付けていきます。ちなみに、MySQLのバージョン5.7.16を使用しております。

Answer 2

自分はよく配列にしています。たとえば検索欄があり、そこに名前、住所、年齢などが送られてきたとき
命名規則を考えて名称をつけると冗長な場合もあるので

$ar_words['age'] = $_POST['age'];
$ar_words['name'] = $_POST['name'];
$ar_words['address'] = $_POST['address'];

このようにすればすっきりするし、検索条件をまとめてsqlのプレースホルダにまとめて代入したりする場合に便利なので。

また、配列は$ar_という接頭辞をつけることでこれは配列であるということをひと目で分かるようにしています。

また、フラグなど目的を表す変数の場合ですが、単に判定用のフラグなら$xxxx_flg、インクリメント用のカウントならば$xxx_numという風にどの目的で使用しているフラグなのかということがわかるようにしています。

Comments

[yayak]

>配列は$ar_という接頭辞をつける
確かに一目で配列だとわかりますね！
自分の中で一貫したフラグの付け方を今後意識してみようと思います！
わかりやすく教えてくださり心より感謝申し上げます。有難うございます<(_ _)>