標籤:google 代碼風格
摘抄精簡Google 開源項目風格指南:
http://zh-google-styleguide.readthedocs.org/en/latest/contents/
一. 命名規則永遠不要使用單詞縮寫(如count寫成cnt)
變數名:
小寫字母,底線串連,一般用名詞,如error_count
類的成員變數以底線結尾,如my_exciting_member_variable_
結構體的資料變數,小寫字母,底線串連
全域變數,首碼g_ ,如g_global_variable
常量:
加首碼k,如kDaysInAWeek
類型名:每個單詞大寫首字母,不含底線,如MyClass
函數名:
常規函數:每個單字首大寫,沒有底線 DeleteElement()
取值或設值函數:與存取的變數名匹配(如取得成員變數的值)
如 void set_num_entries(int num_entries) {
num_entries_ = num_entries;
}
宏命名: 全大寫,底線串連
枚舉:使用常量或宏命名方式
檔案命名:全部小寫,可以用底線(_)或中線(-)串連
my_useful_class.cpp (推薦)
my-useful-class.cpp
myusefulcalss.cpp
二. 注釋風格:
// /**/ 要統一,只使用一種
檔案注釋:
著作權聲明,許可證,作者標識
檔案內容注釋:
.h 檔案對聲明的類的功能和用法做簡單說明
.c 檔案對實現細節或演算法技巧 簡單描述
類注釋:
每個類的定義都要附帶一份注釋,描述類的功能和用法
函數注釋:
函式宣告:描述函數功能和用法,此處不會描述函數如何工作
* 函數的輸入輸出
* 參數是否可以為NULL
* 描述函數對空間的分配和釋放
* 是否存在效能隱患
函數定義:描述函數功能和實現要點
如,編程技巧、大致實現步驟、為何如此實現
變數注釋:
普通變數:其本身足以說明用途,不需注釋
全域變數:必須注釋含義及用途
類資料成員:必須說明用途,如變數可接受NULL或-1等警戒值,必須說明
實現注釋:
代碼前注釋:對巧妙或複雜的程式碼片段前注釋
行注釋:在行尾空2格注釋 (如果連續多行注釋,應對齊)
傳入參數注釋:對傳入的NULL,bool,整數等說明含義(或者使用常量使望文生義)
三. 格式
函式宣告和定義:
函數類型和函數名必須同一行;
函數名和左圓括弧之間無空格;
圓括弧和參數之間無空格;
左大括弧在函數最後一個參數同一行的末尾處;
右大括弧單獨一行
int functions(double x, double y) { return x+y; }
函數返回值:
return運算式不用圓括弧, return x; // not return(x);
條件/迴圈語句:
* if 和左圓括弧之間有個空格,右圓括弧與左大括弧之間有個空格
* else 和 if 的 右大括弧同一行
if (condition) { } else { }
* 簡短並且沒有else的條件陳述式可寫在同一行
if (i == 0) return NULL;
* 單行不需要大括弧
指標和參考資料表達式:
句點或箭頭前後不要有空格. 指標/地址操作符 (*, &) 之後不能有空格.
預先處理指令:
所有都從行首開始,無縮排,即使處於縮排代碼塊中
// Good - directives at beginning of line if (lopsided_score) { #if DISASTER_PENDING // Correct -- Starts at beginning of line DropEverything(); #endif BackToNormal(); }
類格式:
聲明順序public, protected, private 從行首縮排一個空格
C/C++ 代碼規範: 命名規則、注釋、格式