C语言代码规范(编程规范)
生活随笔
收集整理的這篇文章主要介紹了
C语言代码规范(编程规范)
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
首頁 > 編程筆記 > C語言筆記 閱讀:7,165
雖然我們不按照規范也不會出錯,但是那樣代碼寫得就會很亂。大家剛開始學習C語言的時候,第一步不是說要把程序寫正確,而是要寫規范。因為如果你養成一種非常不好的寫代碼的習慣,代碼就會寫得亂七八糟,等到將來工作面試的時候,這樣的習慣可能會讓你失去機會。
有很多知識,比如為什么代碼要這樣寫,為什么不能那樣寫,作為一個初學者你是很難弄明白的。有很多規范是為了在程序代碼量很大的時候,便于自己閱讀,也便于別人閱讀。
所以剛開始的時候有很多規范你不知道為什么要那樣規定,你就單純地模仿就行了。等將來敲代碼敲得時間長了,你就會感覺到那樣寫是很有好處的。
在一般情況下,根據軟件工程的思想,我們的注釋要占整個文檔的20%以上。所以注釋要寫得很詳細,而且格式要寫得很規范。
第二個好處是,把代碼寫規范則程序不容易出錯。如果按照不規范的格式輸入代碼的話,很容易出錯。而代碼寫規范的話即使出錯了查錯也會很方便。格式雖然不會影響程序的功能,但會影響可讀性。程序的格式追求清晰、美觀,是程序風格的重要構成元素。
規則一:定義變量后要空行。盡可能在定義變量的同時初始化該變量,即遵循就近原則。如果變量的引用和定義相隔比較遠,那么變量的初始化就很容易被忘記。若引用了未被初始化的變量,就會導致程序出錯。
規則二:每個函數定義結束之后都要加空行。
總規則:兩個相對獨立的程序塊、變量說明之后必須要加空行。比如上面幾行代碼完成的是一個功能,下面幾行代碼完成的是另一個功能,那么它們中間就要加空行。這樣看起來更清晰。
規則二:函數名之后不要留空格,應緊跟左括號(,以與關鍵字區別。
規則三:(向后緊跟;)、,、;這三個向前緊跟;緊跟處不留空格。
規則四:,之后要留空格。如果;不是一行的結束符號,其后要留空格。
規則五:賦值運算符、關系運算符、算術運算符、邏輯運算符、位運算符,如 =、==、!=、+=、-=、*=、/=、%=、>>=、<<=、&=、^=、|=、>、<=、>、>=、+、-、*、/、%、&、|、&&、||、<<、>>、^ 等雙目運算符的前后應當加空格。
注意,運算符“%”是求余運算符,與 printf 中 %d 的“%”不同,所以 %d 中的“%”前后不用加空格。
規則六:單目運算符 !、~、++、--、-、*、& 等前后不加空格。
注意:
總之,規則六中的是單目運算符,而規則五中的是雙目運算符,它們是不一樣的。
規則七:像數組符號[]、結構體成員運算符.、指向結構體成員運算符->,這類操作符前后不加空格。
規則八:對于表達式比較長的 for 語句和 if 語句,為了緊湊起見,可以適當地去掉一些空格。但 for 和 if 后面緊跟的空格不可以刪,其后面的語句可以根據語句的長度適當地去掉一些空格。例如:
規則一:{和}分別都要獨占一行。互為一對的{和}要位于同一列,并且與引用它們的語句左對齊。
規則二:{}之內的代碼要向內縮進一個 Tab,且同一地位的要左對齊,地位不同的繼續縮進。
還有需要注意的是,很多編程軟件是會“自動對齊”的,比如:
此外編程軟件還有“對齊、縮進修正”功能。就是按 Ctrl+A 全選,然后按 Alt+F8,這時程序中所有成對的大括號都會自動對齊,未縮進的也會自動縮進。不管是在編程過程中,還是在編寫結束完之后,都可以使用這個技巧。但如果完全按照規范寫,那根本就不需要這個技巧,所以,這只是一個輔助功能。
規則二:if、else、for、while、do 等語句自占一行,執行語句不得緊跟其后。此外,非常重要的一點是,不論執行語句有多少行,就算只有一行也要加{},并且遵循對齊的原則,這樣可以防止書寫失誤。
規則一:注釋是對代碼的“提示”,而不是文檔。程序中的注釋不可喧賓奪主,注釋太多會讓人眼花繚亂。
規則二:如果代碼本來就是清楚的,則不必加注釋。例如:
規則三:邊寫代碼邊注釋,修改代碼的同時要修改相應的注釋,以保證注釋與代碼的一致性,不再有用的注釋要刪除。
規則四:當代碼比較長,特別是有多重嵌套的時候,應當在段落的結束處加注釋,這樣便于閱讀。
規則五:每一條宏定義的右邊必須要有注釋,說明其作用。
以下程序的功能是把任何一個一元二次方程 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; } # 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
大家不用關心程序的邏輯和思路,只關注代碼規范即可。
C語言代碼規范(編程規范)
C語言中文網推出輔導班啦,包括「C語言輔導班、C++輔導班、算法/數據結構輔導班」,全部都是一對一教學:一對一輔導 + 一對一答疑 + 布置作業 + 項目實踐 + 永久學習。QQ在線,隨時響應!
什么叫規范?在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;
}
#include <stdio.h>
int main(void)
{
??? if (…)
??? {
??????? while (…)
??? }
??? return 0;
}
此外編程軟件還有“對齊、縮進修正”功能。就是按 Ctrl+A 全選,然后按 Alt+F8,這時程序中所有成對的大括號都會自動對齊,未縮進的也會自動縮進。不管是在編程過程中,還是在編寫結束完之后,都可以使用這個技巧。但如果完全按照規范寫,那根本就不需要這個技巧,所以,這只是一個輔助功能。
6) 代碼行
規則一:一行代碼只做一件事情,如只定義一個變量,或只寫一條語句。這樣的代碼容易閱讀,并且便于寫注釋。規則二:if、else、for、while、do 等語句自占一行,執行語句不得緊跟其后。此外,非常重要的一點是,不論執行語句有多少行,就算只有一行也要加{},并且遵循對齊的原則,這樣可以防止書寫失誤。
7) 注釋
C語言中一行注釋一般采用//…,多行注釋必須采用/*…*/。注釋通常用于重要的代碼行或段落提示。在一般情況下,源程序有效注釋量必須在 20% 以上。雖然注釋有助于理解代碼,但注意不可過多地使用注釋。規則一:注釋是對代碼的“提示”,而不是文檔。程序中的注釋不可喧賓奪主,注釋太多會讓人眼花繚亂。
規則二:如果代碼本來就是清楚的,則不必加注釋。例如:
i++;? //i加1
這個就是多余的注釋。規則三:邊寫代碼邊注釋,修改代碼的同時要修改相應的注釋,以保證注釋與代碼的一致性,不再有用的注釋要刪除。
規則四:當代碼比較長,特別是有多重嵌套的時候,應當在段落的結束處加注釋,這樣便于閱讀。
規則五:每一條宏定義的右邊必須要有注釋,說明其作用。
實際案例
下面我們給出一段求一元二次方程的代碼,讓大家實際感受一下。雖然這個程序不包含所有的規范,但一些包含的規范我們可以對照著看看。以下程序的功能是把任何一個一元二次方程 ax2+bx+c=0 的解給求出來。 復制純文本復制
該一元二次方程有一個唯一解,x1 = x2 = -1.000000
大家不用關心程序的邏輯和思路,只關注代碼規范即可。
小結
單純地讀完一遍肯定沒什么感覺,沒關系,要想把代碼寫規范不是一朝一夕的事,這應該是一種習慣,需要不停地敲、不停的積累。剛開始的時候多模仿,照著規范寫就行了,以后在寫代碼的時候,情不自禁地就會按規范的方式書寫了。所有教程
- 編程視頻
- C語言入門
- C語言專題
- C語言編譯器
- C語言編程實例
- GCC編譯器
- C++教程
- OpenCV
- STL
- vi命令
- Linux入門
- Linux命令
- Shell腳本
- Java教程
- 設計模式
- Java Swing
- JSP教程
- CSS教程
- Go語言教程
- 編程筆記
- 資源下載
優秀文章
- C語言求回文素數
- C語言輸出等腰三角形
- Linux rmp命令管理(安裝、升級和卸載)RMP包方法詳解
- Java生成隨機數(random()和random類)
- linux mkfs命令詳解:格式化分區(為分區寫入文件系統)
- linux端口及查詢方法詳解
- Linux日志分析工具(logwatch)安裝及使用
- Java UDP通信:Java DatagramSocket類和DatagramPacket類
- C++ for循環詳解
- 二分搜索算法(C++詳解版)
總結
以上是生活随笔為你收集整理的C语言代码规范(编程规范)的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 【代码规范】google开源c\c++项
- 下一篇: 十大滤波算法程序大全