変数名のこだわりについて

質問

私はＣ言語始めて１０ヶ月ぐらいのものなのですが、
現在ゲームプログラミングを学んでいます。

Ｃ言語で用いている変数名や関数名、クラスのオブジェクト名
など、本当に適当につけていたのですが、
最近とてつもなくソースコードが読みにくくて
変数名のつけ方に規則みたいなものを作ろうと思うのですが、

どなたかゲームプログラミングなどのプログラミング
をやっている方々、参考までに、どんな風に名前をつけているか
を教えてください。

そういうことを記述しているサイトでもかまいません。
よろしくお願いします。

回答No.4

PG_RankB · ベストアンサー

私もゲーム、システムを仕事や趣味で手掛ける事が多いですが、概ねjacta様と同様ですので、少し具体的に。

１．アクセススコープを明確にする。
グローバルはg_と付ける。ローカルはthe_と付ける。仮引数は入力、出力、入出力を、i_ o_ io_等とする。
これだけでも変数が何処で宣言されたかが分かるので、関数内部が膨らんだ時には助けられる事が多いです。(無駄に膨らます事自体、あまり良くは無いですが)

２．データ型を付ける。
int型ならi float型ならf、構造体ならst等と、プレフィックスを付けますが、これは場合によってはやらない方が良かったりします。
(後々のメンテナンス等で、データ型が変わる事も有りうるので)
仕事上規約であれば従いますが、私はあまり使いません。
※構造体メンバに対し、m_と付けるのは割と使います。

３．ポインタにはpを付ける。
これも２と同様、好みの問題もありそうですが、私は使っています。
モジュールの強度や結合度を考える際、どうしてもポインタを介してデータを渡す事が多くなり、ポインタ部分は間違いが起こり易いので、自戒の念を込めてと言う感じです。
ダブル、トリプルポインタになる場合等は、p2,p3等としています。

４．ループカウンタは一文字変数にしてしまう。
変に～cnt等と命名するより、単純なループ用のイテレータであれば、i,j,kまたは、a,b,c辺りで表現するのがCによく見られる形であり、分かりやすいと思います。

５．変数は名詞的に、関数は動詞から始める等。
変数はデータを入れる器であり、関数は動作を定義する部分です。構造化、オブジェクト指向にも等しく言える事ですが、役割が分かりやすく、命名にも統一感があると読み易いです。

何度も書いていると、この部分は無駄とか、こうした方が便利とか、色々洗練されて来ると思います。
一概に答えの無い物ですが、後は経験を積めば良いと思います。

お礼

ご回答感謝します。
変数名につける文字の例まで記述していて、
とてもいいと思いました。
データ型ごとに文字を付け加えれば以外に
見やすいですね。
ありがとうございました。

回答No.5

Oh-Orange

★私の命名規則をご紹介します。
(1)変数名の先頭に『ハンガリアン文字』を付けます。→独自の表記もある
　TCHAR chMoji;
　TCHAR szBuff[];
　INT nData;
　LONG lData;
　BYTE bByte;
　WORD wWord;
　DWORD dwSize;
　LPTSTR lpBuff;
　LPTSTR *ppBuff;
(2)変数名、関数名ともに単語単位で先頭文字を大文字にします。
　NowPage
　MaxPage
　FuncReadFile
　FuncWriteFile
(3)関数名の先頭は一般的なものは『Func』から始め、それ以外ではまとまった機能で統一させます。
　FuncReadInit
　FuncReadFile
　FuncReadImage
(4)グローバル変数は構造体(MainSysなど)で管理します。
　MainSys.nData
　MainSys.lData
　MainSys.dwSize
　MainSys.lpBuff
(5)ループカウンタは『ハンガリアン文字』は付けずに簡略化します。
　i, j, k, no
(6)座標用変数(サイズ変数)などは『x』、『y』を付けます。
　bx, by ⇒ベース座標
　cx, cy ⇒開始座標,カーソル座標,一般座標
　ex, ey ⇒終了座標
　mx, my ⇒相対移動、絶対移動の座標
　px, py ⇒一般ピクセル座標
　rx, ry ⇒半径ピクセル座標
　sx, sy ⇒縦横サイズ
　wx, wy ⇒ウインドウ座標
(7)初期化関数、後始末関数は『Init』、『Term』を付けます。
　FuncGameInit();
　FuncGameTerm();
(8)動的確保/解放の関数には『Open』、『Close』を付けます。
　FuncBuffOpen();
　FuncBuffClose();
(9)構造体(共用体)の型は先頭に『st』、『lp』、『pp』を付けて大文字で統一させます。
　struct tag_t {
　　INT nData;
　　：
　　INT nTemp;
　} stDATA, *lpDATA, **ppDATA;
(10)デバッグ用の関数名は先頭に『Debug』を付けます。
　DebugDialogBox
　DebugPrintf
　DebugWriteFile
(11)一時的なテスト関数名には先頭に『Test』を付けます。
　TestInit
　TestSample
　TestWriteFile
(12)プロシージャ内のメッセージ部分は『WM_』と同じ名前を付けます。
　FuncInitDialog() ⇒WM_INITDIALOG
　FuncCommand() ⇒WM_COMMAND
　FuncMouseMove() ⇒WM_MOUSEMOVE
　FuncCtlColorStatic() ⇒WM_CTLCOLORSTATIC
・以上です。命名規則の参考にして下さい。

お礼

アドバイス感謝します。
変数名の記述例をこんなに記述してもらえるとは
思っていませんでした。
とても統一していて見やすいですね。
参考にしてきれいなプログラミングを心がけてみます。

回答No.3

jacta

私の場合は、次の3点に注意しています。

1. スコープを明確にする。局所変数と大域変数は、なるべく一目で違いがわかるようにする。ただし、定数はどちらでも大差ないので、それほどこだわらなくてもよいでしょう。C++なら、using指令は避けて、std::○○のようにフルネームで書くか、非常に長い場合は名前空間に別名を付けるとよいでしょう。

2. 重要度に応じて重みを付ける。重要な変数には、省略せずにフルスペルで記述するのに対し、ごく狭い範囲でしか使わないループカウンタのようなものは短い記号で済ませる。

3. 同じ概念に対しては同じ名前を付ける。ありがちなミスとして、仕様書を日本語で作成し、コーディング時にメンバーが各自で（一人の場合も、その時々で）英訳したために、同じものを指すのに複数の訳語ができてしまい、訳がわからなくなることがあります。そんなことになるぐらいなら、日本語で命名した方がましです。

ところで、ハンガリアン記法に関しては、次のURLも参考にしてください。
http://www.radiumsoftware.com/hungarian_notation.html

お礼

回答ありがとうございます。
＞1. スコープを明確にする。
＞2. 重要度に応じて重みを付ける。
＞3. 同じ概念に対しては同じ名前を付ける。
私もこの３点を注意し、きれいなプログラミングを
していこうと思います。
ありがとうございました。

回答No.2

koko_u

ハンガリアン記法は Win32API のマニュアルでしか最早見ないですね。

私は使ってませんが、GNU Coding Standard とかも使われてるのかな？

個人でプログラミングしているなら、結局「意味のある名前をつける」くらいで良いかと。ルールを増やしてもどうせ忘れちゃうし。。。
ついでに裏ルールとして「意味のある名前が付けられない場合には、設計を見直す」

参考URL：

http://www.gnu.org/prep/standards/

お礼

アドバイス感謝します。
”意味のある名前”ですね。
頑張ります。

回答No.1

world_kyoto

有名なのはハンガリアンですね

http://live.under.jp/todashou/tips/code_writting/notation.html

参考にどうぞ。

仕事でプログラミングをやることになったら
その仕事毎に命名方法は違うかもしれませんが参考になると思います。

参考URL：

http://live.under.jp/todashou/tips/code_writting/notation.html

お礼

ハンガリアン命名規約なんてあるなんて知りませんでした。
いいサイトのご紹介ありがとうございました。