什麽叫規範?在C語言中不遵守編譯器的規定,編譯器在編譯時就會報錯,這個規定叫作規則。但是有一種規定,它是一種人爲的、約定成俗的,即使不按照那種規定也不會出錯,這種規定就叫作規範。
雖然我們不按照規範也不會出錯,但是那樣代碼寫得就會很亂。大家剛開始學習C語言的時候,第一步不是說要把程序寫正確,而是要寫規範。因爲如果你養成一種非常不好的寫代碼的習慣,代碼就會寫得亂七八糟,等到將來工作面試的時候,這樣的習慣可能會讓你失去機會。
那麽代碼如何寫才能寫得很規範呢?代碼的規範化不是說看完本節內容後就能實現的。它裏面細節很多,而且需要不停地寫代碼練習,不停地領悟,慢慢地才能掌握的一種編程習慣。所以大家不要想著一下子就能把代碼規範化的所有知識全部掌握,也不要想著一下子就能把代碼寫規範,這是不太可能的。
有很多知識,比如爲什麽代碼要這樣寫,爲什麽不能那樣寫,作爲一個初學者你是很難弄明白的。有很多規範是爲了在程序代碼量很大的時候,便于自己閱讀,也便于別人閱讀。
所以剛開始的時候有很多規範你不知道爲什麽要那樣規定,你就單純地模仿就行了。等將來敲代碼敲得時間長了,你就會感覺到那樣寫是很有好處的。
代碼規範化的第一個好處就是看著很整齊、很舒服。假如你現在用不規範的方式寫了一萬行代碼,現在能看得懂,但等過了三個月你再回頭看時就很吃力了,更不要說給別人看了。所以代碼要寫規範,比如加注釋就是代碼規範化的一個思想。
在一般情況下,根据软件工程的思想,我们的注释要占整个文档的20%以上。所以注释要写得很詳細,而且格式要写得很规范。
第二個好處是,把代碼寫規範則程序不容易出錯。如果按照不規範的格式輸入代碼的話,很容易出錯。而代碼寫規範的話即使出錯了查錯也會很方便。格式雖然不會影響程序的功能,但會影響可讀性。程序的格式追求清晰、美觀,是程序風格的重要構成元素。
代碼規範化基本上有七大原則,體現在空行、空格、成對書寫、縮進、對齊、代碼行、注釋七方面的書寫規範上。
空行起着分隔程序段落的作用。空行得体将使程序的布局更加清晰。空行不会浪费內存,虽然打印含有空行的程序会多消耗一些纸张,但是值得。
規則一:定義變量後要空行。盡可能在定義變量的同時初始化該變量,即遵循就近原則。如果變量的引用和定義相隔比較遠,那麽變量的初始化就很容易被忘記。若引用了未被初始化的變量,就會導致程序出錯。
規則二:每個函數定義結束之後都要加空行。
總規則:兩個相對獨立的程序塊、變量說明之後必須要加空行。比如上面幾行代碼完成的是一個功能,下面幾行代碼完成的是另一個功能,那麽它們中間就要加空行。這樣看起來更清晰。
規則一:关键字之后要留空格。像 const、case 等关键字之后至少要留一个空格,否则无法辨析关键字。像 if、for、while 等关键字之后应留一个空格再跟左括号(
,以突出關鍵字。
規則二:函數名之後不要留空格,應緊跟左括號(
,以與關鍵字區別。
規則三:(
向後緊跟;)
、,
、;
這三個向前緊跟;緊跟處不留空格。
規則四:,
之後要留空格。如果;
不是一行的結束符號,其後要留空格。
规则五:赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符,如 =、==、!=、+=、-=、*=、/=、%=、>>=、<<=、&=、^=、|=、>、<=、>、>=、+、-、*、/、%、&、|、&&、||、<<、>>、^ 等双目运算符的前后应当加空格。
注意,运算符“%”是求余运算符,与 printf 中 %d 的“%”不同,所以 %d 中的“%”前后不用加空格。
规则六:单目运算符 !、~、++、--、-、*、& 等前后不加空格。
注意:
總之,規則六中的是單目運算符,而規則五中的是雙目運算符,它們是不一樣的。
規則七:像數組符號[]
、結構體成員運算符.
、指向結構體成員運算符->
,這類操作符前後不加空格。
规则八:对于表达式比较长的 for 语句和 if 语句,为了紧凑起见,可以适当地去掉一些空格。但 for 和 if 后面紧跟的空格不可以删,其后面的语句可以根据语句的长度适当地去掉一些空格。例如:
for (i=0; i<10; i++)
for 和分号后面保留空格就可以了,=
和<
前後的空格可去掉。
成对的符号一定要成对书写,如 ()、{}。不要写完左括号然后写内容最后再补右括号,这样很容易漏掉右括号,尤其是写嵌套程序的时候。
缩进是通过键盘上的 Tab 键实现的,缩进可以使程序更有层次感。原则是:如果地位相等,则不需要缩进;如果属于某一个代码的内部代码就需要缩进。
對齊主要是針對大括號{}
說的:
規則一:{
和}
分別都要獨占一行。互爲一對的{
和}
要位于同一列,並且與引用它們的語句左對齊。
規則二:{}
之内的代码要向内缩进一个 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,这时程序中所有成对的大括号都会自动对齐,未缩进的也会自动缩进。不管是在编程过程中,还是在编写结束完之后,都可以使用这个技巧。但如果完全按照规范写,那根本就不需要这个技巧,所以,这只是一个辅助功能。
規則一:一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且便于写注释。
規則二:if、else、for、while、do 等语句自占一行,执行语句不得紧跟其后。此外,非常重要的一点是,不论执行语句有多少行,就算只有一行也要加{}
,並且遵循對齊的原則,這樣可以防止書寫失誤。
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
大家不用關心程序的逻辑和思路,只关注代码规范即可。
單純地讀完一遍肯定沒什麽感覺,沒關系,要想把代碼寫規範不是一朝一夕的事,這應該是一種習慣,需要不停地敲、不停的積累。剛開始的時候多模仿,照著規範寫就行了,以後在寫代碼的時候,情不自禁地就會按規範的方式書寫了。
轉自:http://c.biancheng.net/view/158.html
原文地址:https://www.cnblogs.com/zhjblogs/p/14987924.html