C++代碼書寫規範

(聲明:本博客參考自簡書網頁https://www.jianshu.com/p/c1b6cf190e0b   如下內容是讀後結合本人編程經驗分享我對代碼規範的理解和建議)c++

 1、前述程序員

  代碼做爲程序員與計算機溝通的工具,其重要性不言而喻,但在漫漫的編程長路中,不可能一直是自主編程的,小組合做是必不可少的。所以,代碼的規範性由此就顯得十分重要,假若你書寫了不規範、給人以直觀醜陋感,那麼你的搭檔就難以修改你書寫的代碼,甚至會拒絕合做。所以,做爲代碼初學者,掌握必要的代碼規範知識是最基本的,本博客以c++爲例子,舉例分析代碼規範。編程

 2、實例分析函數

1. 善用空格與空行工具

  ①正確使用空格和空行能給人以溫馨感,而不是一連串緊密的代碼給人的壓迫感。spa

  函數名以後不要留空格,不然形參表示不明顯代碼規範

  如:int Fun1(int x)  //建議書寫code

    int Fun2 (int x)  //不建議書寫blog

 

  ②if、 for、 while等判斷和循環使用到的關鍵字以後應留一個空格再跟左括號‘ (’,以突出關鍵字。get

  如: if (i = 0)

 

  ③定義變量的逗號以後要留空格。在for語句中的分號其後要留空格。

  如:

for (i=0; i<5; i++)    int a, b;

 

 

  ④賦值操做符、比較操做符、算術操做符、邏輯操做符、位域操做符,如「 =」、「 +=」 「>=」、「 <=」、「 +」、「 *」、「 %」、「 &&」、「 <<」、 「 ^」等先後應當加空格。

  如: a = b; a += 10;

 

  ⑤在實現函數時,函數與函數之間應加空行,以方便區分兩個不一樣的函數。

  如:

void Fun1(int x)   {     //do something
   }   void Fun2(double y)   {     //do something
   }

 

 

  PS: 過度使用空格也不是好的代碼規範,應適當使用,如這樣就不合適:for( int i = 0 ; i < 10 ; i ++ ) 這樣濫用空格給人很空的感受。

 

2. 注意每行代碼的內容

  一行代碼就作一件事情,不要將全部功能壓縮至一行語句中。

  如: 

int main()   {     int num; double count; while (num <= 100) num++; return 0;  //很差的代碼規範
   }     int main()   {     int num;     double count;     while(num <= 100)   {     num++;   }     return 0;   }

 

 

3. 變量、函數名命名規範

  ①變量,函數,文件命名最好採用英文單詞或詞組,不要使用拼音,或者無心義的a b c之類的,用英文單詞或其縮寫命名能起到在缺乏註釋的狀況下可以給閱讀者起提示做用。

  ②類名和函數名用大寫字母開頭能和普通變量區分開。

  我的喜好使用的命名規範:雙駝峯命名法:

  雙駝峯命名法就是當變量名由多個單詞組合而成時,第一個單詞以小寫字母開始,第2、3、四……N個單詞的首字母大寫。例如:myFirstWord,這樣的變量名看上去就像駱駝峯同樣此起彼伏,既美觀,又能突出由詞組命名的變量,減少衝突命名的可能性。

 

4. 適時添加註釋

  有時候讀代碼會跟不上編程者的思惟,若代碼旁邊沒有註釋,就難以理解其意思,所以適當添加註釋不只可以讓本身回憶某行、某段代碼的用處,還能方面閱讀者理解。

  建議在每一個函數名的後面添加對該函數的功能進行解釋的註釋,同時建議在main函數的每個循環也最好添加註釋,讓閱讀者明白循環的做用。

 

以上是我閱讀參考博客的讀後感和建議,但願本身可以好好記住這些規範,書寫優美又實用的代碼。

相關文章
相關標籤/搜索