c語言編程規(guī)約

實(shí)用標(biāo)準(zhǔn)文案文檔編號 產(chǎn)品版本 密級V1.0 保密產(chǎn)品名稱：語言編程規(guī)約(內(nèi)部使用)精彩文檔實(shí)用標(biāo)準(zhǔn)文案擬制： 日期：審核： 日期：審核： 日期：批準(zhǔn)： 日期：修訂記錄日期 修訂版本 描述 作者精彩文檔實(shí)用標(biāo)準(zhǔn)文案前言編程規(guī)約應(yīng)建立與一項(xiàng)工程支出， 且該規(guī)約應(yīng)貫穿整個工程之始終。 采用一些規(guī)約有助于提供勞動生產(chǎn)率，并使團(tuán)隊(duì)工程軟件便于維護(hù)。慣用的、號的書寫風(fēng)格以及他人用的一些好方法?？梢赃_(dá)到以下目的：可移植性好兼容性好干凈整齊易維護(hù)性好易看懂簡明扼要無論采用什么樣的編程風(fēng)格， 必須在整個工程中采用始終如一的格式。 對于一項(xiàng)大工程的整個團(tuán)隊(duì)建議使用同一的編程風(fēng)格。所以，本團(tuán)隊(duì)試用一下 C語言編程規(guī)約來規(guī)范程序的書寫方法。采用共同的編寫風(fēng)格， 可以少發(fā)生一些程序維護(hù)中令人頭痛的事情， 降低維護(hù)成本；采用統(tǒng)一的書寫方法有助于避免代碼的重復(fù)編寫。C源代碼的寬度限制在 80個字符。使用 Fixedsys 字體9號字。源代碼超出部分需要將源代碼分成兩行書寫且將注釋書寫于頭上。 除了必要的英文外， 本團(tuán)隊(duì)約定所有注釋一律使用中文。不得使用英文及其它語言。新來的團(tuán)隊(duì)人員在編寫代碼前應(yīng)先認(rèn)真閱讀本規(guī)約。 以便快速了解和掌握本關(guān)于軟件編寫規(guī)范。一、文件頭以下是 C語言程序的文件頭。公司的名稱和地址可寫在前幾行；然后是標(biāo)題，標(biāo)出文精彩文檔實(shí)用標(biāo)準(zhǔn)文案件的主題內(nèi)容；接著是著作權(quán)聲明，以表明軟件的專有權(quán)。然后是關(guān)于侵權(quán)的警告說明及購買本軟件的聯(lián)系方式。/*******************************************************************************有限公司* CN_uOS實(shí)時(shí)操作系統(tǒng)** 此文件屬于 CN_uOS實(shí)時(shí)操作系統(tǒng)的一個子文件， XXXXXXXX 有限公司對其有所有版 *權(quán)及保留意見。任何復(fù)制和發(fā)布本軟件的公司及個人，我們將對其追究最終法律責(zé)任。* 需要使用部分或全部軟件代碼的公司及個人需同 XXXXXXXX 有限公司聯(lián)系。網(wǎng)址：*文件名：*版本：*描述：*作者：*日期：函數(shù)列表：******************************************************************************/二、文件包含精彩文檔實(shí)用標(biāo)準(zhǔn)文案應(yīng)用工程需要的頭文件緊跟在版本變更記錄的后面。 本團(tuán)隊(duì)約定將所有頭文件包含在一個名為 includes.h 的頭文件中。除了因要發(fā)布為庫的頭文件外，所有的應(yīng)用程序頭文件都應(yīng)遵循此約定，不得例外。文件包行的注釋格式為：/*******************************************************************************頭文件******************************************************************************/#include “includes.h ”三、標(biāo)志符命名法變量名申明應(yīng)該是每行一個變量， 而不要在一行中聲明多個變量， 這樣易于給每一個變量加上注釋。形式參數(shù)：在函數(shù)中應(yīng)只用小寫字母自動變量名：應(yīng)只用小寫字母靜態(tài)變量和函數(shù)：應(yīng)使用文件名或模塊名（或部分文件名、模塊名）為前綴。大小寫字母混用。外部變量和函數(shù)：應(yīng)使用文件名或模塊名（或部分文件名、模塊名）為前綴。大小寫字母混用。四、縮寫、略語及助記符在給變量和函數(shù)等標(biāo)志符命名時(shí)可以使用縮寫、 略語及助劑符。使用縮寫可以使較少的字符描述標(biāo)志符。但容易引起混亂和誤解。為保證其正確性。團(tuán)隊(duì)要求，在每個工程項(xiàng)中應(yīng)使用一張助記詞表作為說明。以便查閱。一本有效的詞典對于一個團(tuán)隊(duì)來說可以提供勞動生產(chǎn)率。不僅是在單獨(dú)的程序中，應(yīng)在整個工程項(xiàng)目中始終保持前后一致。助記表格式如下：縮寫、略語及助劑符 含義Addr AddressBlk Block精彩文檔實(shí)用標(biāo)準(zhǔn)文案五、注解如果代碼與注解混在一起，就會很難閱讀；因此，不混合編寫代碼和注解，注解應(yīng)寫在代碼的右邊。當(dāng)需要將注解寫的較長時(shí)，以函數(shù)描述注解塊的形式來寫。團(tuán)隊(duì)規(guī)定。每個函數(shù)前都應(yīng)加函數(shù)描述塊來描述。每行代碼都必須加注釋。公司規(guī)定在C中，除了注解和文件頭等大型說明外，行注釋一律使用//來注釋而不用/**/注釋方式。函數(shù)描述塊格式：/******************************************************************************* 函 數(shù)名：函數(shù)功能：輸入?yún)?shù)：輸出參數(shù)：*作 者：*日 期：**-------------------------------------------------------------------------------------------------------------------修改者：修改日期：******************************************************************************/六、數(shù)據(jù)類型C語言允許使用 typedef 關(guān)鍵字定義新的數(shù)據(jù)類型。公司規(guī)定將使用下列數(shù)據(jù)類型重定義C語言中標(biāo)準(zhǔn)數(shù)據(jù)類型來統(tǒng)一規(guī)范。/*******************************************************************************數(shù)據(jù)類型******************************************************************************/typedefunsignedcharI8B;//布爾型typedefunsignedcharI8U;//8位無符號型typedefcharI8S;//8位有符號型typedefunsignedintI16U;//16位無符號型typedefintI16S;//16位有符號型typedefunsignedlongI32U;//32位無符號型typedeflongI32S;//32位有符號型typedeffloatFP;//浮點(diǎn)數(shù)精彩文檔實(shí)用標(biāo)準(zhǔn)文案結(jié)構(gòu)體 s_聯(lián)合體 u_枚舉體 e_函數(shù) f_I8U uc_I8S sc_I16U us_I16S ss_I32U ui_I32S si_FP32 ft_FP64 de_數(shù)組 ay_指針 p_宏定義 m_全局變量 _X局部變量 _x七、縮進(jìn)格式縮進(jìn)格式是表達(dá)函數(shù)流程的重要手段。本文使用 TAB鍵來縮進(jìn)，值得注意的是不同的編輯軟件對 TAB鍵的定義不一樣。公司規(guī)定使用 TAB鍵作為縮進(jìn)， TAB=4個空格鍵八、語句和書寫格式語句和表達(dá)式應(yīng)在一行中寫完，超出部分可使用 符鏈接到下一段書寫但必須對其與原句。公司規(guī)定每個 {}必須獨(dú)立占用一行。對于賦值語句必須按列對齊。九、結(jié)構(gòu)、聯(lián)合、枚舉結(jié)構(gòu)定義需用typedef定義的，可用一個標(biāo)志符名代表整個結(jié)構(gòu)。結(jié)構(gòu)類型的申明一律使用大小寫混和。typedefstructSYS_RAM{// 定義RAM結(jié)構(gòu)I8ULineW;// 定義線寬I8ULineH;// 定義線高}Sys_Ram;typedefstructSYS_ROM{// 定義ROM結(jié)構(gòu)SYS_Ramsys_ram;// 定義RAM結(jié)構(gòu)精彩文檔實(shí)用標(biāo)準(zhǔn)文案I8Utype;// 定義類型}Sys_Rom;公司規(guī)定使用位域 +宏定義來定義位變量。typedefstruct{unsignedcharb7:1;unsignedcharb6:1;unsignedcharb5:1;unsignedcharb4:1;unsignedcharb3:1;unsignedcharb2:1;unsignedcharb1:1;unsignedcharb0:1;}BYTE_FIELD;typedefstruct{unsignedintb15:1;unsignedintb14:1;unsignedintb13:1;unsignedintb12:1;unsignedintb11:1;unsignedintb10:1;unsignedintb9:1;unsignedintb8:1;unsignedintb7:1;unsignedintb6:1;unsignedintb5:1;unsignedintb4:1;unsignedintb3:1;unsignedintb2:1;unsignedintb1:1;unsignedintb0:1;}WORD16_FIELD;typedefunion{unsignedchar byte;BYTE_FIELD bit;}TYPE_BYTE;typedefunion{unsignedint word;unsignedchar byte[2];精彩文檔實(shí)用標(biāo)準(zhǔn)文案WORD_FIELD16 bit;}TYPE_WORD16;公司規(guī)定當(dāng)一個宏定義為一個結(jié)構(gòu)時(shí)，須使用枚舉類型進(jìn)行定義。typedefenum{LOW,HIGH}e_LevelState; //電平狀態(tài)十、指針公司規(guī)定使用在對函數(shù)傳值調(diào)用時(shí)，優(yōu)先使用指針結(jié)構(gòu)。指針規(guī)范詳請見 C語言。公司規(guī)定規(guī)定使用函數(shù)指針進(jìn)行數(shù)據(jù)封裝。應(yīng)大部分 C中未對此進(jìn)行詳細(xì)講解。故在此對函數(shù)指針的特殊用法進(jìn)行講解。 以便公司成員可以在程序中使用和閱讀此類型時(shí)不會陌生。同時(shí)在公司編寫的驅(qū)動庫中間大量使用此結(jié)構(gòu)。詳請見， 《B&B嵌入式軟件開發(fā)規(guī)范》。#include<stdio.h>typedefvoid(*pfn)(void);typedefunion {pfnfirst;int(*ifn)(inta,intb);void(*vfn)(int,int);}msg;intOnInt(inta,intb){printf("a=%d,b=%d\r\n",a,b);returna;}voidOnVoid(int