C語言命名規范示例


一、命名約定——變量名

(1)公共對象(變量)與公共函數(即具有全局性)應使用指示符作為前綴(即源代碼文件)。

(2)所有對象均由字母、數字、下划線構成。若是文件內部對象,只能采用小寫字母。若是全局對象(即外部鏈接)應加前綴。

(3)所有文件范圍對象應在源代碼文件中聲明。所有全局范圍的對象應在頭文件中聲明。定義類型適用的最小可能范圍。

(4)對不同的或冗余文件將使用由下划線與單個字母組成的后綴(egtim_get_time_A.ctim_get_time_B.c)。

(5)函數參數列表名稱:函數內部的變量名應被維持至函數邊界。

二、命名約定——函數名

(1)函數名由字母、數字、下划線構成,盡量使用由單個動詞和單個名詞組成的名字。

(2)面向對象的相關函數應含有動詞,后跟下划線與object_name(對象名)。

(3)函數名前綴”is”或”is_”應保留個布爾型函數以專門返回boolean_t等布爾型。例如:isflower()。

三、命名約定——常量名

(1)聲明(即單獨一行無參數申明#define),利用類型限定如const的對象與枚舉量將被指為常量。

(2)整型、字符型與浮點型常量命令,無論其使用范圍,均可由下划線與字母構成:大寫字母與數字,小寫字母與數字並以”_k”為后綴。

(3)后綴”_k”被保留用於整型、字符型與浮點型常量命名

(4)使用符號量代替文字提高代碼的可讀性與維護性

      例如:

          Ifspeed_value=234

      可重寫為:

          static const uint16 speed_max_k=234

          Ifspeed_value=speed_max_k);

(5)枚舉常量應由大寫字母與下划線字符構成

例如:

   typedef enum {BLACK,RED,GREEN} font_color_t

四、命名約定——宏名

    

五、命名約定——類型別名

類型別名的命名應由小寫字母與下划線構成。所有的類名應具有后綴”_t”(非union型)與”_u”union型)。后綴”_t”與”_u”保留給類型別名。

六、命名約定——成員名

   結構體與聯合體名應遵循與變量名相同的命名約定

 

七、保留關鍵字

   保留字或關鍵詞的使用限定是明確的。

  “_g”后綴保留給全局變量,可選。

  “_k”后綴保留給整型、字符型、浮點型常量名,必選。

  “_t”后綴保留給typedef申明不包括union型,必選。

  “_u”后綴保留給typedef申明union型,必選。

備注:文檔中記錄的C語言編寫條例可作為程序設計參考,來進行程序的編寫設計,提高程序代碼編寫質量,增強代碼可讀性。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM