1. 程式人生 > >C語言程式碼規範(程式設計規範)

C語言程式碼規範(程式設計規範)

C語言程式碼規範(程式設計規範)

什麼叫規範?在C語言中不遵守編譯器的規定,編譯器在編譯時就會報錯,這個規定叫作規則。但是有一種規定,它是一種人為的、約定成俗的,即使不按照那種規定也不會出錯,這種規定就叫作規範。

雖然我們不按照規範也不會出錯,但是那樣程式碼寫得就會很亂。大家剛開始學習C語言的時候,第一步不是說要把程式寫正確,而是要寫規範。因為如果你養成一種非常不好的寫程式碼的習慣,程式碼就會寫得亂七八糟,等到將來工作面試的時候,這樣的習慣可能會讓你失去機會。

程式碼如何寫才能規範

那麼程式碼如何寫才能寫得很規範呢?程式碼的規範化不是說看完這篇文章後就能實現的。它裡面細節很多,而且需要不停地寫程式碼練習,不停地領悟,慢慢地才能掌握的一種程式設計習慣。所以大家不要想著一下子就能把程式碼規範化的所有知識全部掌握,也不要想著一下子就能把程式碼寫規範,這是不太可能的。

有很多知識,比如為什麼程式碼要這樣寫,為什麼不能那樣寫,作為一個初學者你是很難弄明白的。有很多規範是為了在程式程式碼量很大的時候,便於自己閱讀,也便於別人閱讀。

所以剛開始的時候有很多規範你不知道為什麼要那樣規定,你就單純地模仿就行了。等將來敲程式碼敲得時間長了,你就會感覺到那樣寫是很有好處的。

程式碼規範化的好處

程式碼規範化的第一個好處就是看著很整齊、很舒服。假如你現在用不規範的方式寫了一萬行程式碼,現在能看得懂,但等過了三個月你再回頭看時就很吃力了,更不要說給別人看了。所以程式碼要寫規範,比如加註釋就是程式碼規範化的一個思想。

在一般情況下,根據軟體工程的思想,我們的註釋要佔整個文件的20%以上。所以註釋要寫得很詳細,而且格式要寫得很規範。

第二個好處是,把程式碼寫規範則程式不容易出錯。如果按照不規範的格式輸入程式碼的話,很容易出錯。而程式碼寫規範的話即使出錯了查錯也會很方便。格式雖然不會影響程式的功能,但會影響可讀性。程式的格式追求清晰、美觀,是程式風格的重要構成元素。

程式碼規範化的七大原則

程式碼規範化基本上有七大原則,體現在空行、空格、成對書寫、縮排、對齊、程式碼行、註釋七方面的書寫規範上。

1、空行

空行起著分隔程式段落的作用。空行得體將使程式的佈局更加清晰。空行不會浪費記憶體,雖然列印含有空行的程式會多消耗一些紙張,但是值得。

規則一:定義變數後要空行。儘可能在定義變數的同時初始化該變數,即遵循就近原則。如果變數的引用和定義相隔比較遠,那麼變數的初始化就很容易被忘記。若引用了未被初始化的變數,就會導致程式出錯。

規則二:每個函式定義結束之後都要加空行。

總規則:兩個相對獨立的程式塊、變數說明之後必須要加空行。比如上面幾行程式碼完成的是一個功能,下面幾行程式碼完成的是另一個功能,那麼它們中間就要加空行。這樣看起來更清晰。

2、空格

規則一:關鍵字之後要留空格。像 const、case 等關鍵字之後至少要留一個空格,否則無法辨析關鍵字。像 if、for、while 等關鍵字之後應留一個空格再跟左括號(,以突出關鍵字。

規則二:函式名之後不要留空格,應緊跟左括號(,以與關鍵字區別。

規則三:(向後緊跟;),;這三個向前緊跟;緊跟處不留空格。

規則四:,之後要留空格。如果;不是一行的結束符號,其後要留空格。

規則五:賦值運算子、關係運算符、算術運算子、邏輯運算子、位運算子,如 =、==、!=、+=、-=、*=、/=、%=、>>=、<<=、&=、^=、|=、>、<=、>、>=、+、-、*、/、%、&、|、&&、||、<<、>>、^ 等雙目運算子的前後應當加空格。

注意,運算子“%”是求餘運算子,與 printf 中 %d 的“%”不同,所以 %d 中的“%”前後不用加空格。

規則六:單目運算子 !、~、++、--、-、*、& 等前後不加空格。

注意:

  • 這裡的“-”和規則五里面的“-”不同。這裡的“-”是負號運算子,規則五里面的“-”是減法運算子。
  • 這裡的“*”和規則五里面的“*”也不同。這裡的“*”是指標運算子,規則五里面的“*”是乘法運算子。
  • 這裡的“&”和規則五里面的“&”也不同。這裡的“&”是取地址運算子,規則五里面的“&”是按位與運算子。


總之,規則六中的是單目運算子,而規則五中的是雙目運算子,它們是不一樣的。

規則七:像陣列符號[]、結構體成員運算子.、指向結構體成員運算子->,這類操作符前後不加空格。

規則八:對於表示式比較長的 for 語句和 if 語句,為了緊湊起見,可以適當地去掉一些空格。但 for 和 if 後面緊跟的空格不可以刪,其後面的語句可以根據語句的長度適當地去掉一些空格。例如:

for (i=0; i<10; i++)

for 和分號後面保留空格就可以了,=<前後的空格可去掉。

3、成對書寫

成對的符號一定要成對書寫,如 ()、{}。不要寫完左括號然後寫內容最後再補右括號,這樣很容易漏掉右括號,尤其是寫巢狀程式的時候。

4、縮排

縮排是通過鍵盤上的 Tab 鍵實現的,縮排可以使程式更有層次感。原則是:如果地位相等,則不需要縮排;如果屬於某一個程式碼的內部程式碼就需要縮排。

5、對齊

對齊主要是針對大括號{}說的:

規則一:{}分別都要獨佔一行。互為一對的{}要位於同一列,並且與引用它們的語句左對齊。

規則二:{}之內的程式碼要向內縮排一個 Tab,且同一地位的要左對齊,地位不同的繼續縮排。

還有需要注意的是,很多程式設計軟體是會“自動對齊”的,比如:

#include <stdio.h>
int main(void)
{
    if (…)
    return 0;
}

寫完 if 那一行後,按回車,此時游標在括號的右邊,而此 if 下的大括號要寫在與 if 左對齊的正下方,通常我們是按一下 Backspace 鍵使游標停在與 if 左對齊的正下方。但事實上我們不需要這樣做,我們直接輸入大括號即可,系統會自動對齊到與 if 左對齊的正下方。再接著看:

#include <stdio.h>
int main(void)
{
    if (…)
    {
        while (…)
    }
    return 0;
}

寫完 while 那一行後,按回車,此時游標不是停在與 while 左對齊的正下方,同樣,我們不需要按 Backspace,直接輸入大括號即可,系統會自動對齊到與 while 左對齊的正下方的。

此外程式設計軟體還有“對齊、縮進修正”功能。就是按 Ctrl+A 全選,然後按 Alt+F8,這時程式中所有成對的大括號都會自動對齊,未縮排的也會自動縮排。不管是在程式設計過程中,還是在編寫結束完之後,都可以使用這個技巧。但如果完全按照規範寫,那根本就不需要這個技巧,所以,這只是一個輔助功能。

6、程式碼行

規則一:一行程式碼只做一件事情,如只定義一個變數,或只寫一條語句。這樣的程式碼容易閱讀,並且便於寫註釋。

規則二:if、else、for、while、do 等語句自佔一行,執行語句不得緊跟其後。此外,非常重要的一點是,不論執行語句有多少行,就算只有一行也要加{},並且遵循對齊的原則,這樣可以防止書寫失誤。

7、註釋

C語言中一行註釋一般採用//…,多行註釋必須採用/*…*/。註釋通常用於重要的程式碼行或段落提示。在一般情況下,源程式有效註釋量必須在 20% 以上。雖然註釋有助於理解程式碼,但注意不可過多地使用註釋。

規則一:註釋是對程式碼的“提示”,而不是文件。程式中的註釋不可喧賓奪主,註釋太多會讓人眼花繚亂。

規則二:如果程式碼本來就是清楚的,則不必加註釋。例如:

i++;  //i加1

這個就是多餘的註釋。

規則三:邊寫程式碼邊註釋,修改程式碼的同時要修改相應的註釋,以保證註釋與程式碼的一致性,不再有用的註釋要刪除。

規則四:當代碼比較長,特別是有多重巢狀的時候,應當在段落的結束處加註釋,這樣便於閱讀。

規則五:每一條巨集定義的右邊必須要有註釋,說明其作用。

實際案例

下面我們給出一段求一元二次方程的程式碼,讓大家實際感受一下。雖然這個程式不包含所有的規範,但一些包含的規範我們可以對照著看看。

以下程式的功能是把任何一個一元二次方程 ax2+bx+c=0 的解給求出來。

# include <stdio.h>
# include <math.h> /*因為要用到求平方函式sqrt(),所以要包含標頭檔案 math.h*/
int main(void)
{
    //把三個係數儲存到計算機中
    int a = 1;  // “=”不表示相等,而是表示賦值
    int b = 2;
    int c = 1;
    double delta;   //delta存放的是b*b - 4*a*c的值
    double x1, x2;  //分別用於存放一元二次方程的兩個解
    delta = b*b - 4*a*c;
    if (delta > 0)
    {
        x1 = (-b + sqrt(delta)) / (2*a);
        x2 = (-b - sqrt(delta)) / (2*a);
        printf("該一元二次方程有兩個解,x1 = %f, x2 = %f\n", x1, x2);
    }
    else if (0 == delta)
    {
        x1 = (-b) / (2*a);
        x2 = x1;  //左邊值賦給右邊
        printf("該一元二次方程有一個唯一解,x1 = x2 = %f\n", x1);
    }
    else
    {
        printf("無解\n");
    }
    return 0;
}

執行結果:
該一元二次方程有一個唯一解,x1 = x2 = -1.000000

大家不用關心程式的邏輯和思路,只關注程式碼規範即可。

小結

單純地讀完一遍肯定沒什麼感覺,沒關係,要想把程式碼寫規範不是一朝一夕的事,這應該是一種習慣,需要不停地敲、不停的積累。剛開始的時候多模仿,照著規範寫就行了,以後在寫程式碼的時候,情不自禁地就會按規範的方式書寫了。