スタッフBLOG

おはようございます。本日の当番、新人プログラマーのS.Kです。

僕は昔から物事を忘れやすいので、何かとよくメモを取るようにしています。
ですが、書く内容と順番がバラバラになってしまい分かりにくいのでメモを書き直すなんて事をする時があります。
初めから書く内容と場所を決めていれば問題ないのですが・・・。


そしてそれはプログラムでも同じ事が言えます。
コーディングルールを全く決めていないと、
『自分で書いたプログラムなのに書き方がバラバラで何をしているか分からない』
なんて事になってしまいます。

例えば、とあるクラスのあるメンバ変数は先頭に記述されているのに末尾などの別の場所にも記述が散りばめられていたりすると、メンバ変数を知りたい時にどこを見ればいいの？となってしまいます。

他にも次の例の様な事が起こります。
■悪い例
class Player
{
private:
　 float x;
　 float y;

public:
　 関数～(略)

private:
　 unsigned short life;

public:
　 関数～(略)

private:
　 char name[32];
　 int *work;
};

この場合はどこが悪いのか？ですが、
・メンバ変数がどこにあるのか見つけ辛い
・変数名からメンバ変数なのか一時変数なのかの見分けがつかない
・変数名から変数型が読み取れない
・クラスの定義が長くなる
と言った問題があります。


そこでこの問題を解消する為に一般的なコーディングルールを取り入れます。
C++などでよく使われている例を簡単に挙げると以下があります。
・クラス名には先頭にCを付ける
・メンバ変数はクラスの先頭(又は末尾)に記述する
・メンバ変数には先頭にm_を付ける
・変数には先頭に変数型を示す文字を付ける(例：int iTemp)

では悪い例に上記のルールを取り入れたクラスを書いてみましょう。
■良い例
class CPlayer
{
private:
　 float　　　　　m_fX;
　 float　　　　　m_fY;
　 unsigned short m_usLife;
　 char　　　　　 m_cName[32];
　 int　　　　　　*m_pWork;

public:
　 (以下略)
};

さてどうでしょう。
悪い例と比べてスッキリしたものにする事ができました。
そして悪い点として挙げていたものも解消できています。

こんなふうにルールが決まっていると確認しやすくなり、見た目も良くなります。
他にもコメントの書き方や関数の書き方など事細かに決める事があります。

会社やチーム、個人によってコーディングルールは様々ですが、
これからプログラマーになろうとしている学生の方もコーディングルールを決める事で見易く奇麗なプログラムを目指してみましょう！！

そんな事を言っている僕のプログラムは汚いですけども・・・。