天天看點

編碼規範(一)

編碼規範不是硬性要求,這隻是良好的習慣,好習慣可以避免很多不必要的失誤,我今天就簡單的講述一下,在程式設計時我們應該注意什麼。

1.在程式的排版方面,一開始我們應該用便于講述此程式的作用

2.寫頭檔案時,标準庫檔案用<>包含,非标準庫檔案用“”包含。

3.應盡量使用宏定義常量,便于後期的修改和維護

4.使用四字縮進,最好使用空格縮進,不要用tab鍵,避免各個系統tab縮進不同。

5.保證一行隻寫一個程式,如果一個程式過長,可分行寫,但請盡量保持相同種類的寫在一列,清晰明了。for,while,if,do等語句,請盡量隻占一行,就算隻有一個語句,也要用 { } 括起來,并且各占一行,不要怕使用換行,系統不計算空行的記憶體。

6.定義變量時,保證一行隻定義一個變量,并且同種類型的變量放在一起,不同類型變量之間空一行。

7.不同子產品間要空一行,比如寫了一個功能,在寫下一個功能時請空一行,怎麼讓人看的舒服怎麼來。

8.運算符之間應留有空格,比如for(i = 0; i < 10; i++),不要把程式都堆在一起,适當留有空格,讓人看的舒緩。

9.程式之間應該對齊,不管是語句還是括号{},都要對齊,讓人一目了然。

10.修飾符緊靠變量,這樣可以知道是哪個變量的修飾符,避免混淆。

11.注釋不要多,但要有,隻起解釋說明作用,不要羅裡吧嗦的,隻簡單提一下就可。

12.命名時,使用英文單詞組合,動詞加名詞,比如get_num,insert _ ch等。能夠望名生意。

13.使用多個運算符運算時,不要使用預設優先級,自己加括号,保證程式準确。

14.語句嵌套使用時,請嚴格按照四格縮進,不要圖省事。

15.寫函數時,函數名恰當合理,形參傳回值寫完整,有就有,沒有就void。

以上是總體上排版上應該這麼寫,要想達到高效優美的程式,還有很多路要走,還有很多注意點,比如入口參數檢查,傳回值判斷(異常處理)等。

繼續閱讀