コーディング規則　命名規則

タイトル

データ

読み コーディングきそく　めいめいきそく
属性 プログラムTIPS
種類 ソースコード記述の際のルール
能力 クラス名、関数名などの命名規則一例

概要

ソースコードを書く時、各々が違った書き方で書いていては他人のソースコードを読むことができなくなってしまう。
そこで、ここにソースコードを書く時のルールの一例を記す。

ここでは関数

• ファイル名(ソースコード)
• 変数(ローカル、グローバル、クラス変数)
• 定数
• 関数(グローバル、クラス)
• クラス(フィールド、メソッド)に名前をつける時の規則を記す。

部員全員が同じルールでコメントをつけたり、変数等の名前をつけたらソースコードも見やすくなると思うんだ。
よかったら講習会でこのルールひろめてくれ。

命名規則

基本ルール

• 英語表記

ソースコードは基本的に英語で記述する。
英語がわからないからといってローマ字で書いたりしない。

• 意味を読み取ることのできる名称

「int DADADA」「void nanigasi(int da, int do)」など、名前から機能や役割を読み取ることのできない名前はつけない

ファイル名

• ソースコード

Main.cpp
MySum.cpp
GameDataLoad.cpp

ソースコードファイル名は内に記述されている関数名、クラス名と同じ名前にする。
小規模なクラス、関数であろうと１つのソースコードには１つのクラス、関数しか記述しない。

• その他

ゲームの画像等は個別の命名規則を作り、その規則にのっとって命名すること。
追記希望。

変数

• 基本

int timeCounter; //時間用カウンタ

小文字で始まり、単語間は次の単語の頭文字を大文字にする。

• ローカル変数

int add;  //足し算の値
int player_lv;  //プレイヤーレベル
int enemy_lv;  //敵レベル

すべて小文字で書く。
単語間のつなぎは「_」アンダーバー。

• グローバル変数

int g_counert;  //カウンター
int g_baseData; //基本データ

そもそもグローバル変数なんて使わないこと。
基本ルールと同じだが、頭に「g_」をつけること。

• クラスフィールド変数

int playerLv;  //プレイヤーのレベル
int playerAttack;  //プレイヤー攻撃力

基本ルールと同じ

• ループカウンタ

for(int i=0; i<10; i++){
 for(int j=0; j<10; j++){
 }
}

ループ内で数をカウントする変数を作る場合、「i,j,k」を用いる

定数

#define FILE_GAME_DATA "GameData.dat"  //ゲームデータファイル名
#define WINDOW_SIZE_WIDTH 640  //ウィンドウ横幅
#define WINDOW_SIZE_HEIGHT 480  //ウィンドウ縦幅

全て大文字で書く。単語間のつなぎは「_」アンダーバー。

関数

• 基本

void Main();
int Add();
int UpDate();
GameData LoadGameData(const char file);

大文字で始まり、単語間は次の単語の頭文字を大文字にして表現する。

クラス

• 基本

class SceneTitle
class PlayerCharacter

大文字で始まり、単語間は次の単語の頭文字を大文字にして表現する。

コメント

• VisualStudioは識別子に日本語使えるんだぜ！?　ローマ字と英語混ぜると見にくいけど、英語と日本語混ぜても読めるよな！ -- f (2011-05-19 13:20:23)
• グローバル変数とか、接頭字つけなくても参照時に::つければよかろ。 -- f (2011-05-19 13:22:32)
• 【重要】関数名の最初は動詞(be動詞でもいい。例: cout.is_good() )、型名やインスタンス名は名詞を使うべし。 -- f (2011-05-19 13:33:03)