軟硬件開發(fā)流程及規(guī)范-資料下載頁(yè)
2025-04-13 02:06本頁(yè)面
【正文】 long lLongInt。 } MYEXAMPLE,* PMYEXAMPLE,FAR * LPMYEXAMPLE。 4。書寫風(fēng)格： A) 函數(shù)：函數(shù)的返回類型一定要寫，不管它是否默認(rèn)類型，函數(shù)的參數(shù)之間應(yīng)用一逗號(hào)加一空格隔開,若有多個(gè)參數(shù)，應(yīng)排列整齊。例如： int SendResetMsg( PTLAPENTITY pLAPEntity, int iErrorNo ) { int iTempValue。 . . . } 函數(shù)的類型和上下兩個(gè)括號(hào)應(yīng)從第一列開始，函數(shù)的第一行應(yīng)縮進(jìn)一個(gè)TAB，不得用空格縮進(jìn)。(按大多數(shù)程序范例，TAB為四個(gè)字符寬，我們規(guī)定：TAB為四個(gè)字符寬。) B) 語(yǔ)句：循環(huán)語(yǔ)句和if語(yǔ)句等塊語(yǔ)句的第一個(gè)大括號(hào)‘{’可跟在第一行的后面，接下來(lái)的語(yǔ)句應(yīng)縮進(jìn)一個(gè)TAB，如： for ( count = 0 。 count MAXLINE 。 count++ ) { if ( (count % PAGELINE) == 0 ) { . . . } . . } 也可另起一行，如： for ( count = 0 。 count MAXLINE 。 count++ ) { if ( (count % PAGELINE) == 0 ) { . . . } . . } 兩種寫法在世界著名的程序員手下均可見到，我們尊重個(gè)人的習(xí)慣，但推薦使用后一種寫法。 復(fù)雜表達(dá)式(兩個(gè)運(yùn)算符以上，含兩個(gè))必須用括號(hào)區(qū)分運(yùn)算順序，運(yùn)算符的前后應(yīng)各有一空格，習(xí)慣寫在一行的幾個(gè)語(yǔ)句(如IF語(yǔ)句)，中間應(yīng)有一空格，其它語(yǔ)句不鼓勵(lì)寫在同一行。 空格加在適當(dāng)?shù)牡胤?，?if ( 。 for ( 。 ) {。 語(yǔ)句的上下對(duì)齊也可使程序便于閱讀，如： = 0。 = 1。 = NULL。 C) 常量：常量一般情況下可用宏定義，用大寫的方式，單詞之間用下劃線隔開 如： define MAX_LINE 100 define PI 不鼓勵(lì)在程序中出現(xiàn)大量的數(shù)字常數(shù)。 注：對(duì)于一些有必要說(shuō)明的縮寫，可以在模塊描述內(nèi)加以說(shuō)明。5。 頭文件：頭文件一般包括了數(shù)據(jù)結(jié)構(gòu)的定義，函數(shù)原形的說(shuō)明，宏定義等，不許包含函數(shù)體和變量實(shí)體，，頭文件的開始可包括如下的注釋：/********************************************************************* CREATE DATE：創(chuàng)建日期 ** CREATED BY ：創(chuàng)建人 ** MODIFIED BY ：修改人 ** USED BY ：由哪些模塊使用 *********************************************************************/ 為了避免重編譯，應(yīng)加上條件編譯語(yǔ)句，： ifndef __HEADFILE_H define __HEADFILE_H . . . endif6161。163。 預(yù)編譯宏：對(duì)于代碼中使用到的預(yù)編譯宏，應(yīng)在文件的適當(dāng)處加以說(shuō)明。對(duì)于連續(xù)多行的宏，在書寫上也采用縮進(jìn)的格式。例如：ifdef _BORLANDC_define FAR fardefine NEAR nearifdef OS_DEBUG define HHH 0x11define JJJ 0x22undef KKKendifelsedefine FARdefine NEARendif對(duì)于夾在代碼中的編譯開關(guān)，在書寫格式上當(dāng)作源代碼一樣處理。例如：…lpPrim = (LPTL2L1PRIM)GetMessage( amp。queL2L1 )。if( lpPrim == NULL ){if OS_DEBUGPrintf(“Queue L2L1 is empty!” )。endifreturn。}… 7。注釋：注釋是源碼中非常重要的部分，不應(yīng)少于源碼行數(shù)的15%，我們希望能達(dá)到25%或更多。注釋用中英文都可以，但應(yīng)易讀易懂。不要在一個(gè)語(yǔ)句的中間插入注釋。 本規(guī)范內(nèi)容符合公司有關(guān)文檔要求，參照了北京研究部的相關(guān)文檔，并聽取了大家的意見，希望諸位在軟件開發(fā)過(guò)程中，能主動(dòng)遵照本規(guī)范，寫出高質(zhì)量的源碼！附 頁(yè)本附頁(yè)的內(nèi)容不是“軟件編程規(guī)范”的一部分，但對(duì)于較大的軟件，值得推薦。1。接口函數(shù)（被其它模塊調(diào)用的函數(shù)）及接口變量（被其它模塊引用的變量），其命名可增加前綴表明其所歸屬的模塊。 如：NLS_MsgProc, NLP_GetPHTime, NLS_LogToConnid ... 由于C的函數(shù)都是全程的，其它函數(shù)也建議增加前綴來(lái)避免重名或混淆。2。頭文件分開定義 A) 自用頭文件：定義模塊自用的函數(shù)，結(jié)構(gòu)，變量等。 B) 輸出頭文件：用于該模塊向外輸出，即別的模塊在使用該模塊提供功能時(shí)需要引用的頭文件，包含該模塊的輸出函數(shù)和輸出數(shù)據(jù)結(jié)構(gòu)，輸出常量。3。建議在使用有一定關(guān)聯(lián)的成組常量時(shí)使用枚舉定義：typedef enum { MONDAY, ..... SUNDAY,} WEEKDAY。在有特殊數(shù)值要求時(shí)在枚舉內(nèi)定義：typedef enum { MONDAY = 1, ....... SUNDAY = 7,} WEEKDAY。好處：容易理解有關(guān)聯(lián)的常量；枚舉變量可以當(dāng)作整型變量使用。28
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1