C語言代碼規范(編程規范)
什么叫規范?在C語言中不遵守編譯器的規定,編譯器在編譯時就會報錯,這個規定叫作規則,但是有一種規定,它是一種人為的、約定成俗的,即使不按照那種規定也不會出錯,這種規定就叫作規范,
雖然我們不按照規范也不會出錯,但是那樣代碼寫得就會很亂,大家剛開始學習C語言的時候,第一步不是說要把程式寫正確,而是要寫規范,因為如果你養成一種非常不好的寫代碼的習慣,代碼就會寫得亂七八糟,等到將來作業面試的時候,這樣的習慣可能會讓你失去機會,
代碼如何寫才能規范
那么代碼如何寫才能寫得很規范呢?代碼的規范化不是說看完本節內容后就能實作的,它里面細節很多,而且需要不停地寫代碼練習,不停地領悟,慢慢地才能掌握的一種編程習慣,所以大家不要想著一下子就能把代碼規范化的所有知識全部掌握,也不要想著一下子就能把代碼寫規范,這是不太可能的,
有很多知識,比如為什么代碼要這樣寫,為什么不能那樣寫,作為一個初學者你是很難弄明白的,有很多規范是為了在程式代碼量很大的時候,便于自己閱讀,也便于別人閱讀,
所以剛開始的時候有很多規范你不知道為什么要那樣規定,你就單純地模仿就行了,等將來敲代碼敲得時間長了,你就會感覺到那樣寫是很有好處的,
代碼規范化的好處
代碼規范化的第一個好處就是看著很整齊、很舒服,假如你現在用不規范的方式寫了一萬行代碼,現在能看得懂,但等過了三個月你再回頭看時就很吃力了,更不要說給別人看了,所以代碼要寫規范,比如加注釋就是代碼規范化的一個思想,
在一般情況下,根據軟體工程的思想,我們的注釋要占整個檔案的20%以上,所以注釋要寫得很詳細,而且格式要寫得很規范,
第二個好處是,把代碼寫規范則程式不容易出錯,如果按照不規范的格式輸入代碼的話,很容易出錯,而代碼寫規范的話即使出錯了查錯也會很方便,格式雖然不會影響程式的功能,但會影響可讀性,程式的格式追求清晰、美觀,是程式風格的重要構成元素,
代碼規范化的七大原則
代碼規范化基本上有七大原則,體現在空行、空格、成對書寫、縮進、對齊、代碼行、注釋七方面的書寫規范上,
- 空行
空行起著分隔程式段落的作用,空行得體將使程式的布局更加清晰,空行不會浪費記憶體,雖然列印含有空行的程式會多消耗一些紙張,但是值得,
規則一:定義變數后要空行,盡可能在定義變數的同時初始化該變數,即遵循就近原則,如果變數的參考和定義相隔比較遠,那么變數的初始化就很容易被忘記,若參考了未被初始化的變數,就會導致程式出錯,
規則二:每個函式定義結束之后都要加空行,
總規則:兩個相對獨立的程式塊、變數說明之后必須要加空行,比如上面幾行代碼完成的是一個功能,下面幾行代碼完成的是另一個功能,那么它們中間就要加空行,這樣看起來更清晰,
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
大家不用關心程式的邏輯和思路,只關注代碼規范即可,
小結
單純地讀完一遍肯定沒什么感覺,沒關系,要想把代碼寫規范不是一朝一夕的事,這應該是一種習慣,需要不停地敲、不停的積累,剛開始的時候多模仿,照著規范寫就行了,以后在寫代碼的時候,情不自禁地就會按規范的方式書寫了,
轉載請註明出處,本文鏈接:https://www.uj5u.com/qita/229804.html
標籤:其他
