C語言編程規範概要

編程規範概要

一、 程序結構清析，簡單易懂，單個函數的程序行數不得超過100行。

二、 打算幹什麼，要簡單，直截了當，代碼精簡，避免垃圾程序。

三、 儘可能使用標準庫函數和公共函數。

四、 不要隨意定義全局變量，儘可能使用局部變量。

五、 使用括號以免二義性。

 

可讀性要求

一、可讀性第一，效率第二。

二、保持註釋與代碼徹底一致。

三、每一個源程序文件，都有文件頭說明，說明規格見規範。

四、每一個函數，都有函數頭說明，說明規格見規範。

五、主要變量（結構、聯合、類或對象）定義或引用時，註釋能反映其含義。

六、常量定義（DEFINE）有相應說明。

七、處理過程的每一個階段都有相關注釋說明。

八、在典型算法前都有註釋。

九、利用縮進來顯示程序的邏輯結構，縮進量一致並以Tab鍵爲單位(定義Tab爲 6個字節)

十、循環、分支層次不要超過五層。

十一、註釋能夠與語句在同一行，也能夠在上行。

十二、空行和空白字符也是一種特殊註釋。

1三、一目瞭然的語句不加註釋。

1四、註釋的做用範圍能夠爲：定義、引用、條件分支以及一段代碼。

1五、註釋行數(不包括程序頭和函數頭說明部份)應占總行數的1/5 到 1/3 。