您好,登錄后才能下訂單哦!
今天就跟大家聊聊有關C語言編程規(guī)范有哪些,可能很多人都不太了解,為了讓大家更加了解,小編給大家總結了以下內容,希望大家根據(jù)這篇文章可以有所收獲。
1.基本規(guī)則
格式清晰、注釋簡明扼要、命名規(guī)范易懂、函數(shù)模塊化、程序易讀易維護、功能準確實現(xiàn)、代碼空間效率和時間效率高、適度的可擴展性、單片機編程規(guī)范-標識符命名。
2.標識符命名
2.1命名基本原則
(1)命名清晰明了,有明確含義,使用完整單詞或約定俗成的縮寫。通常,較短的單詞可通過去掉元音字母形成縮寫;較長的單詞可取單詞的頭幾個字母形成縮寫。即"見名知意"。
(2)命名風格要自始至終保持一致。
(3)命名中若使用特殊約定或縮寫,要有注釋說明。
(4)同一軟件產(chǎn)品內模塊之間接口部分的標識符名稱之前加上模塊標識。
2.2宏和常量命名
宏和常量用全部大寫字母來命名,詞與詞之間用下劃線分隔。對程序中用到的數(shù)字均應用有意義的枚舉或宏來代替。
2.3變量命名
變量名用小寫字母命名,每個詞的第一個字母大寫。類型前綴(u8\s8 etc.)全局變量另加前綴g_。
局部變量應簡明扼要。局部循環(huán)體控制變量優(yōu)先使用i、j、k等;局部長度變量優(yōu)先使用len、num等;臨時中間變量優(yōu)先使用temp、tmp等。
2.4函數(shù)命名
函數(shù)名用小寫字母命名,每個詞的第一個字母大寫,并將模塊標識加在最前面。
2.5文件命名
一個文件包含一類功能或一個模塊的所有函數(shù),文件名稱應清楚表明其功能或性質。每個.c文件應該有一個同名的.h文件作為頭文件。
3.注釋
3.1注釋基本原則
有助于對程序的閱讀理解,說明程序在"做什么",解釋代碼的目的、功能和采用的方法。一般情況源程序有效注釋量在30%左右。注釋語言必須準確、易懂、簡潔。邊寫代碼邊注釋,修改代碼同時修改相應的注釋,不再有用的注釋要刪除。匯編和C中都用"//",取消";"不使用段注釋" /**/ "(調試時可用)
3.2文件注釋
文件注釋必須說明文件名、函數(shù)功能、創(chuàng)建人、創(chuàng)建日期、版本信息等相關信息。修改文件代碼時,應在文件注釋中記錄修改日期、修改人員,并簡要說明此次修改的目的。所有修改記錄必須保持完整。文件注釋放在文件頂端,用"/*……*/"格式包含。注釋文本每行縮進4個空格;每個注釋文本分項名稱應對齊。
/***********************************************************
文件名稱:
作者:
版本:
說明:
修改記錄:
***********************************************************/
3.3函數(shù)注釋
3.3.1函數(shù)頭部注釋
函數(shù)頭部注釋應包括函數(shù)名稱、函數(shù)功能、入口參數(shù)、出口參數(shù)等內容。如有必要還可增加作者、創(chuàng)建日期、修改記錄(備注)等相關項目。函數(shù)頭部注釋放在每個函數(shù)的頂端,用"/*……*/"的格式包含。其中函數(shù)名稱應簡寫為Name(),不加入、出口參數(shù)等信息。
/***********************************************************
函數(shù)名稱:
函數(shù)功能:
入口參數(shù):
出口參數(shù):
備注:
***********************************************************/
3.3.2代碼注釋
代碼注釋應與被注釋的代碼緊鄰,放在其上方或右方,不可放在下面。如放于上方則需與其上面的代碼用空行隔開。一般少量注釋應該添加在被注釋語句的行尾,一個函數(shù)內的多個注釋左對齊;較多注釋則應加在上方且注釋行與被注釋的語句左對齊。函數(shù)代碼注釋用"//…//"的格式。
通常,分支語句(條件分支、循環(huán)語句等)必須編寫注釋。其程序塊結束行"}"的右方應加表明該程序塊結束的標記"end of……",尤其在多重嵌套時。
3.4變量、常量、宏的注釋
同一類型的標識符應集中定義,并在定義之前一行對其共性加以統(tǒng)一注釋。對單個標識符的注釋加在定義語句的行尾。全局變量一定要有詳細的注釋,包括其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時的注意事項等。注釋用"//…//"的格式。
4.函數(shù)
4.1函數(shù)設計原則
函數(shù)的基本要求:
1)封裝性
1)正確性:程序要實現(xiàn)設計要求的功能。
2)穩(wěn)定性和安全性:程序運行穩(wěn)定、可靠、安全。
3)可測試性:程序便于測試和評價。
4)規(guī)范/可讀性:程序書寫風格、命名規(guī)則等符合規(guī)范。
5)擴展性:代碼為下一次升級擴展留有空間和接口。
6)全局效率:軟件系統(tǒng)的整體效率高。
7)局部效率:某個模塊/子模塊/函數(shù)的本身效率高。
編制函數(shù)的基本原則:
1)單個函數(shù)的規(guī)模盡量限制在200行以內(不包括注釋和空行)。一個函數(shù)只完成一個功能。
2)函數(shù)局部變量的數(shù)目一般不超過5~10個。
3)函數(shù)內部局部變量定義區(qū)和功能實現(xiàn)區(qū)(包含變量初始化)之間空一行。
4)函數(shù)名應準確描述函數(shù)的功能。通常使用動賓詞組為執(zhí)行某操作的函數(shù)命名。
5)函數(shù)的返回值要清楚明了,尤其是出錯返回值的意義要準確無誤。
6)不要把與函數(shù)返回值類型不同的變量,以編譯系統(tǒng)默認的轉換方式或強制的轉換方式作為返回值返回。
7)減少函數(shù)本身或函數(shù)間的遞歸調用。
8)盡量不要將函數(shù)的參數(shù)作為工作變量。
4.2函數(shù)定義
1)函數(shù)若沒有入口參數(shù)或者出口參數(shù),應用void明確申明。
2)函數(shù)名稱與出口參數(shù)類型定義間應該空一格且只空一格。
3)函數(shù)名稱與括號()之間無空格。
4)函數(shù)形參必須給出明確的類型定義。
5)多個形參的函數(shù),后一個形參與前一個形參的逗號分割符之間添加一個空格。
看完上述內容,你們對C語言編程規(guī)范有哪些有進一步的了解嗎?如果還想了解更多知識或者相關內容,請關注億速云行業(yè)資訊頻道,感謝大家的支持。
免責聲明:本站發(fā)布的內容(圖片、視頻和文字)以原創(chuàng)、轉載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權內容。