はじめに

STGを作っていて、使用する変数が増えたことでいくつか困ることが出てきた。その最たる例が変数名。
変数の命名規則をあらかじめ決めていても、きちんとしたものではなくアバウトすぎるものなのでそもそも問題しかなく、当然ながら途中からは変数名の表記揺れなども発生してきた。
今回はこれを減らし、他人にも見せやすくするためにしっかりと対策をしてみようと思う。

前提として

C#の命名規則・コーディング規則というのがあるらしく、それによるとこうらしい。（調べるまで知らなかったし、意識したこともなかった。）
メソッドの名前：動詞または動詞句を使用。
プロパティの名前：名詞、名詞句、形容詞を使用
フィールド名：Pascal形式を使用。名詞や名詞句を使用する。ただし、プリフィックスを使用しない。
パラメータの名前：Camel形式を使用。意味に基づいた説明的な名前を使用

調べてみた

Microsoftの推奨するガイドラインにはこのようにある
1.プロパティの先頭は大文字
2.変数の先頭は小文字
3.メンバ変数にプレフィックスは付けない
ただ、これらを守るとメンバ変数をpublicにすることができなかったり、長い関数を見るとどれがメンバ変数なのかわかりにくくなる。

一方その頃、Unity Technologiesではメンバ変数には「m_」を付けている。
これをしてみると「候補から探しやすくなり便利」とあった
これまでは全くやったことが無かったので、まずはこれを試してみることにする。

そして、全く意識していなかったが
「複合語は1つの単語とみなし、名前に使う単語は、名前の長さを短くするよりも、わかりやすい名前にすることを優先する。」
というのもあり、複合語に関しては対応していたが、わかりやすい名前にすることを優先はしていなかった。とにかく短く短くすることに執着していた。

次回以降は

とりあえず、メンバ変数に「m_」を使用する。
それから、複合語をなるべく使用し、変数名を短くするよりもわかりやすい名前にすることを優先する。

注釈

メンバ変数：
  クラスの内側かつメソッドの外側で宣言された変数のこと。
  private指定をするとクラス外からは読み書きができない。
  protectedやpublic指定もできる。
Pascal形式：
  各単語の頭文字を大文字にして単語をつなげて表記する形式。
Camel形式：
  最初の単語の頭文字は小文字、その後につなげる単語の頭文字を大文字にする形式。