C/C++代碼格式規範(一)

    在寫代碼的時候,通常需要遵循一定的代碼格式規範,本文針對自己做項目以及所接觸的代碼形式,同時也參考紅帽rpm源碼和谷歌代碼規範,總結一下寫代碼時的編程規範,當然這不是硬性規定,許多地方可以根據自己的喜好進行選擇。規範更多的是爲了讓別人能夠快速看懂你寫的代碼,不用在代碼形式上浪費時間,同時也使代碼更簡潔易懂。

一、爲什麼編寫代碼要有規範?

  • 能夠讓代碼簡潔易懂;
  • 能夠讓同一項目的人快速理解;
  • 好看美觀 ^_^;
  • 同一項目中使用相同的規範,能讓代碼統一,能快速理解代碼;
  • 變量命名不再糾結,哈哈哈!

二、變量命名原則

(1)普通變量

  • 變量開頭字母使用小寫;
  • 變量儘量使用英文單詞名詞;
  • 多個名詞直接相連或使用"_"相連;
  • 多個名詞直接相連時,除第一個名詞外,其它名詞首字母大寫,以便區分單詞;
  • 單詞儘量使用全拼,不要省略,比如install 寫成ins或inst,簡寫不好理解;

例如:

int flag;
int interfaceFlag;
int installInterfaceFlag;

(2)枚舉變量

  • 字母全部大寫;
  • 單詞之間或多個單詞之間使用下劃線連接“_”;
  • 同一類使用相同的前綴(比下面例子中的:FLAG,STUDENTFLAG);

例如:

FLAG_BANANA
FLAG_APPLE
FLAG_ORIGNE
STUDENTFLAG_INFORMATION
STUDENTFLAG_TECNORLEGE

(3)全局變量

  • 全局變量以g開頭,其它遵循普通變量規則;
  • 儘量不用全局變量;

例如:

int  gStudentInformation = 10;
int  gTeacherInformation = 20;

(4)常量

  • 常量以k開頭,其它遵循普通變量規則;

例如:

const int kStudentInformation = 100;
const int kTeacherInformation = 200;

三、循環/條件語句規則

(1)左圓括號和關鍵字之間有一個空格;

(2)右圓括號和左大括號之間有一個空格;

(3)圓括號和表達式/變量之間沒有空格;

(4)左圓括號不單獨佔據一行;

(5)右圓括號單獨佔據一行;

例如:

// <i> 代表此處有幾個空格
if<1>(flag)<1>{
<4>……
}<1>else<1>{
<4>……
}// 單獨佔據一行,與if在同一列

while<1>(flag)<1>{
<4>……
}

for<1>(i = 0; i < n; ++i)<1>{ // 其中,i<1>=<1>0等,這裏不再標明;
<4>……
}

switch<1>(flag)<1>{
case 1: // 與switch在同一列
<4>……
<4>break;    
case 2:
<4>……
<4>break;
default:
<4>……
} 

    今天先總結這些,後續會繼續補充,敬請期待!大家如果有不同的理解可以一塊探討呀!

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章