C語言編碼規範 4 --可讀性


C語言編碼規範1--文件與目錄                         https://blog.csdn.net/RootCode/article/details/93221475

C語言編碼規範 2--排版                                   https://blog.csdn.net/RootCode/article/details/93222263

C語言編碼規範 3 --註釋                                  https://blog.csdn.net/RootCode/article/details/93223912

C語言編碼規範 4 --可讀性                               https://blog.csdn.net/RootCode/article/details/93226117

C語言編碼規範 5--變量、結構、常量、宏       https://blog.csdn.net/RootCode/article/details/93226847

C語言編碼規範 6--函數                                    https://blog.csdn.net/RootCode/article/details/93227533


(1) 注意運算符的優先級,並用括號明確表達式的操作順序,避免使用默認優先級。

說明:防止閱讀程序時產生誤解,防止因默認的優先級與設計思想不符而導致程序出錯。
示例:下列語句中的表達式
正確的寫法:

word = (high << 8) | low;
if ((a | b) && (a & c))
if ((a | b) < (c & d))

錯誤的寫法:

word = high << 8 | low;
if (a | b && a & c)
if (a | b < c & d)         /* 造成了判斷條件出錯 */

(2) 避免使用不易理解的數字,用有意義的標識來替代。涉及物理狀態或者含有物理意義的常量,不應直接使用數字,必須用有意義的枚舉或宏來代替。

示例:如下的程序可讀性差。

if (Trunk[index].trunk_state == 0)     //<---- 不規範的寫法,應使用有意義的標識
{
    Trunk[index].trunk_state = 1;      //<---- 不規範的寫法,應使用有意義的標識
    //...                              /* program code */
}

應改爲如下形式。

enum trunk_state_e
{
    TRUNK_IDLE = 0,
    TRUNK_BUSY = 1
};

if (Trunk[index].trunk_state == TRUNK_IDLE)
{
    Trunk[index].trunk_state = TRUNK_BUSY;
    //...                                 /* program code */
}

(3) 不要使用難懂的技巧性很高的語句,除非很有必要時。
說明:高技巧語句不等於高效率的程序,實際上程序的效率關鍵在於算法。
示例:如下表達式,考慮不周就可能出問題,也較難理解。

* stat_poi ++ += 1;
* ++ stat_poi += 1;


// 應分別改爲如下
*stat_poi += 1;
stat_poi++;                 /* 此二語句功能相當於“ * stat_poi ++ += 1; ”*/

++ stat_poi;
*stat_poi += 1;             /* 此二語句功能相當於“ * ++ stat_poi += 1; ”*/

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章