1. 程式人生 > >《手把手教你學C語言》學習筆記(4)---程式碼規範

《手把手教你學C語言》學習筆記(4)---程式碼規範

程式設計過程中需要遵守編譯器的各種約定,例如以下程式碼:
 1 #include <stdio.h>
 2 
 3 int main(int argc, char **argv)
 4 {
 5     printf("Hello World!\n");
 6 
 7     return 0;                                                     
 8 }
無論多麼簡單的程式,必須能夠通過編譯的檢查和編譯,否則就不能執行。也就是說程式碼需要遵從程式語言的語法規則。我們說的程式碼規範,只是一種約定俗成,會讓你的程式碼更容易閱讀和除錯,讓你更容易進入下一個程式設計境界。
下面說下程式碼的規範,算是個簡單入門吧!
  1. 空行的應用規範:(1)、變數(群)定義後需要加上一個空行;(2)、內部函式實現的前後需要各加一個空行;(3)、return語句前面需要加一個空行;(4)、#include語句後需要加一個空行;(5)、程式碼邏輯功能完整後需要新增一個空行。
  2. 空格的應用規範:(1)、關鍵字後要加一個空格;(2)、函式名與‘(’之間不要加空格;(3)、‘,’、‘;’、‘)’、‘]’和‘}’之前不要加空格;(4)、‘,’之後加一個空格;(5)、雙目運算子的前後需要各加一個空格;(6)、單目運算子前後不加空格;(7)、‘[]’陣列符號、‘.’成員運算子與‘->結構體指標成員運算子’等前後不加空格。
  3. 註釋的應用規範:(1)、一般要求註釋量不低於原始碼的30%;(2)、註釋分為單行註釋和多行註釋,簡單註釋時採用單行註釋;(3)、註釋主要用來理解程式碼,不能用來畫蛇添足;(4)、註釋必須在寫程式碼的過程中書寫,修改程式碼的同時,相關的註釋也必須一併修改;(5)、多重巢狀的開始處需要新增適當的註釋;(6)、每條巨集定義需要添加註釋;(7)、每個方法(函式)前面需要添加註釋,內容包括方法的返回值的意義,方法需要的引數值及方法的作用,有時需要新增上版權資訊。
  4. 程式碼行的應用規範:(1)、原則上一行程式碼只做一件事情,還而言之只寫一條語句;(2)、語句塊需要加上{},即使該語句塊只有一條語句,並且語句塊中的程式碼,根據邏輯不同新增不同的空行和實現不同的對齊;(3)、成對符號的書寫,最好在寫完左半部分後就及時補上右半部分,避免漏寫右半部分;(4)、{}的對齊,需要位於不同的行,但必須位於同一列;(5)、{}內的程式碼同等地位需要左對齊,不同地位的需要繼續向右縮排,一次向右縮排一個層次;(6)、縮排一般通過鍵盤的tab鍵實現,每按一次按鍵增加一個縮排層次,通過不同的縮排使程式程式碼顯得更加有層次感,便於程式碼的閱讀和理解。
    程式碼的規範其實有很多,但是不是必須的,只是為了讓程式碼更整齊,更悅目,更容易閱讀和理解而建立起來的一套規範,對初學者來說,不需要刻意去記憶這些編碼的規範,但是可以通過多次敲寫程式碼,大量的聯絡,不停的積累,以後寫程式碼就會慢慢的形成自己的規範了。建議初學者可以使用適當的工具,個人不建議使用IDE開發工作,如果只是C語言,強烈建議使用VIM編輯器,外加Gcc編譯器和Gdb偵錯程式和make自動編譯工作,比任何一個IDE功能更加強大,使用更加靈活,讓你的學習更加深入。