命名

    命名，包括檔名、類名、結構名、型別名、函式名、變數名、引數名等都是程式設計中重要的一部分。一個好的名稱，體現了一個深思熟慮的過程，同時也能夠幫助別人更好地理解開發者的思路。如果發現程式中，充滿了a, b, c, x, y, z, tmp這種命名的變數，這時候就需要仔細的考慮自己的實現是否有問題，而這個過程是極其困難的，所以命名規範就顯得很有必要性。

類（結構）名

類名必須是名詞，類名必須明確表示這個類代表了什麼。
如果類名超過3個單詞，說明這個類有可能需要拆分了。
不要把父類的名字帶到子類中。
類名加上字尾也是一種選擇。如下載代理類，可以寫為DownloadProxy。
類名首字母大寫；用大寫字母分隔單詞，除單詞的首字母外，全部小寫；類名中不要出現下劃線“_”。
 

類（結構）屬性名

屬性由成員字首”m_“屬性，屬性名採用匈牙利命名規範。

方法

方法與函式執行一個任務，因此應當用動詞來命名。比方說，DumpDataToFile()就要好於DataFile()。
方法名首字母大寫；用大寫字母分隔單詞，除單詞的首字母外，全部小寫，方法名中不要出現下劃線。

函式

方法與函式執行一個任務，因此應當用動詞來命名。
函式名全部小寫，單詞之間用下劃線分隔。

方法與函式引數名

首字母小寫。
除了第一個單詞，所有單詞的首字母大寫。
名稱中不應出現”_”。

類庫名

如果使用C書寫類庫，或在C++不使用namespace書寫類庫，為了避免命名衝突，需要在類名，結構名，函式名前加上類庫名字首。類庫名應當簡潔、明確。 如：
 

    ImEgg* ImEgg_new(); 

變數名

變數名使用匈牙利命名規則。
全部小寫字母。
使用”_”作為分隔符。
唯一能違反以上命名規則的，是一些迴圈中需要用到的自增變數。 如：

    int fun(Point* pPoint)
    {
        Point* p_nest_point = pPoint;
        char* p = NULL;
        char sz_buf[255];
        for (int i = 0; i < 50 && (sz_buf+p++) != ' '; i++)
        {
            // do stuff
 

        }
    }

另外，迴圈變數可根據迴圈變數型別命名，比如：

    p point; w word; ch char; n number; who widechar;

指標變數

指標變數應在型別前加上p字首，其後變數名命名規則不變。
*號永遠靠近型別，一行宣告中只出現一個指標變數。 如：

    Point* p_point;

引用變數

引用變數應在型別前加上r字首，其後變數名命名規則不變。

全域性變數

全用變數應使用g_屬性描述，其後變數名命名規則不變。 如：

    ImLog4c* g_pLogger;

靜態變數

靜態變數應使用s_屬性描述，其後變數名命名規則不變。

    ImLog4c* s_pLogger;

列舉型別

列舉型別命名規則使用大寫字母，用下劃線分隔單詞。

     Enum PIN
     {
         PIN_ON = 1;
         PIN_OFF;
     };

巨集

巨集命名規則使用大寫字母，用下劃線分隔單詞。

    #define MAX_LENGTH 50
    #define MAX(a, b) (a)>(b)?(a):(b)

集合名稱

集合名稱使用複數，其它與變數名規範相同。

    GList* edges = g_list_new();
    vector edges;
    typedef vector EdgeVector;
    typedef map EdgeMap;
    typedef list EdgeList;

格式

{}規則

除了空的情況可以直接“{}”，其他“{“與”}”單獨佔一行，並對齊。
“{“與上一行行首對齊。
If與while後哪怕只有一句話，也要加上“{“與”}”。

    while (*(buf+p++) != ' ')
    {
        printf("hello\n");
    }

()規則

"("與前一個關鍵字之間留一個空格。
"("與前函式名之間不需要留一個空格。
return語句儘可能不要用"()"

    return (a * b^2 > 100) ? (a) : (b);    //儘量不要這樣
    return a * b^2 > 100 ? a : b;          //這種寫法更規範

縮排規則

縮排永遠為4。
用空格代替tab。
Tab永遠用4。
如果縮排超過5層，考慮程式碼優化。

列長度

一列不應該超過80個英文字元。
一個宣告佔一行
一個宣告佔一行。

三元表示式

條件表示式佔一行
then與else應單獨佔一行。

標頭檔案順序

標頭檔案應當按照與功能的特點性從高到低排列。順序為
當前目錄的標頭檔案。
自行開發庫的標頭檔案。
第三方庫的標頭檔案。
標準C++標頭檔案。
標準C標頭檔案。

空格

操作符需要加上空格。
關鍵字前後要加上空格。
逗號後要加上空格。
冒號後要加上空格。
在一行內的分號後要加上空格，行末的分號不要空格。

    fun(a, b);
    for (int I = 0; I < 50; i++);

類與結構

類檔案與結構檔案命名

公有類，C中用以模擬類的結構，需要位於一個獨立的檔案中。
檔名與公有類名，C中用以模擬類的結構名相同。

類與結構標頭檔案佈局

檔案描述，使用Doxygen語法。
標頭檔案保護巨集。
標頭檔案。
類或結構描述，使用Doxygen語法。
類或結構名。
屬性描述，使用Doxygen語法。以下每個屬性或方法都要求對應一個描述。
屬性宣告。
C++與身命週期相關函式宣告。C++中的構造方法，析構方法以及工廠方法。
C++操作符過載。
C++訪問器，get與set方法。