UFQP2-09QI003 VC程序編程規(guī)范

文件編號:UF/QP/2-09/QI/003修改:SEPG審核:SEPG日期:01/10/25版號:1.0draft頁號:3/31PAGEPAGE12024VC程序編程規(guī)范 考慮到易操作性，現(xiàn)將規(guī)范盡量與我們現(xiàn)有的習(xí)慣結(jié)合起來。公司ISO9002規(guī)范：（本規(guī)范必須遵守）軟件著作權(quán):北京用友軟件集團(tuán)有限公司系統(tǒng)名稱:ufo(或財務(wù)分析等)(例子)功能說明:簡要說明本程序的功能相關(guān)文檔:相關(guān)詳細(xì)設(shè)計文檔號變量命名及函數(shù)的約定變量名約定是用小寫字母表示的數(shù)據(jù)類型標(biāo)識符作為變量前綴，變量名的詞首字符應(yīng)大寫，用漢語拼音時，要在前綴后加下劃線符號，詞匯之間也加下劃線符號。如：preGlobalVariable //英語詞匯pre為前綴，GlobalVariable為變量名稱。pre_Quanju_BianLiang //漢語拼音 對于是類中的成變量，在上述的約定的變量形式前加上m_，如m_preGlobalVariable 函數(shù)名詞首字符應(yīng)大寫，如果是漢語拼音則詞匯之間用下劃線連接，如：CmyClass::FunctionName() //英語詞匯CmyClass::HanShu_MingCheng()//漢語拼音類成員前綴：m_preVariablem:代表類成員pre:如前所述的前綴Variable:變量名全局變量前綴：g_preVariableg:代表全局變量pre:如前所述的前綴Variable:變量名 注：盡量使用英語詞匯做變量和函數(shù)名在一個變量和函數(shù)名不可把拼音和英語同用。 用拼音時要有易拼懂性。 前綴所表示的意義見附表。常量及宏定義約定常量及宏定義全部用大寫字母如果是英語詞匯則詞匯之間用下劃線，如果是拼音則每個字的拼音之間用下劃線，如：constint MAX_LINE=100; //英語#define MAX_LINE100 //英語constint ZUI_DA_HANG=100; //拼音#define ZUI_DA_HANG100 //拼音程序注釋的約定規(guī)則：（必須遵守）1、對于程序自己生成的注釋代碼，//TODO行在完成此段代碼后必須刪除。 其他注釋行不可刪除。 2、要使用中文。 3、在函數(shù)體內(nèi)的注釋盡量不使用/*注釋*/形式 4、在一個函數(shù)調(diào)試完成后，經(jīng)整理不可有無用的注釋。 5、注釋不可過多也不可過少。有如下建議：1)、核心模塊或有一定算法的代碼2）、理解時有一定困難的代碼3）、程序框圖中有分支之處4）、類成員以及類方法5）、全局變量、全局函數(shù)和重要函數(shù) 6、函數(shù)體前的注釋格式：（頭文件中函數(shù)的聲明處不用加任何注釋） 對于一些重要的函數(shù)和全局函數(shù)//******************************************************//* 完成功能：簡述函數(shù)或過程的功能 *//*調(diào)用格式：必要時可舉例說明(可選的) *//*參數(shù)：列出主要的、不易理解的參數(shù)含義和取值范圍 *//*返回：返回值含義 *//*對全局變量的影響和其他環(huán)境的影響（可選） *//*調(diào)用本函數(shù)的注意事項(xiàng)（可選） *//* 其他(包括內(nèi)部變量、算法、參考設(shè)計書某頁)(可選) *//*******************************************************程序書寫規(guī)范為了便于代碼的修改和重利用，我們的代碼應(yīng)有較好的可讀性，應(yīng)注意以下幾方面：1）、變量命名遵循上面的規(guī)范。2）、變量的使用應(yīng)盡量精簡。3）、在一函數(shù)中變量定義應(yīng)盡量集中。4）、算法應(yīng)盡量精練，對某算法補(bǔ)遺時，最好重寫算法。5)、要有段落感，該空一行的要空一行，不該空的不空。6)、盡量不使用goto語句。 舉例voidCMyClass::Example(intpara1,intpara2,WORDpara3) //前面不可有任何空格{//第一對括號前面不可有任何空格 int iLoop; //以TAB鍵開始第一行 for(iLoop=0;iLoop<100;iLoop++){ CStringstrTemp; //對于每對括號內(nèi)的語句用TAB鍵縮進(jìn)} //此括號必須與相對的括號的所在行的起始位置對齊if(para1==1){ //不可用空格speace鍵做縮進(jìn)格式}elseif(para1==2){}}//非條件語句時每對括號的垂直位置一致。附表必須遵守的前綴規(guī)范：基本類型意義bBoolean布爾chChar字符dwDoubleWord雙字lLong長型fn Function函數(shù)lLong長型iInteger整形p或lp指針pt Cpointstr Cstringrc Crect v 其它變量（在不執(zhí)行下述表的類型情況下） c 其它類對象（在不執(zhí)行下述表的類型情況下）以下為參照執(zhí)行：前綴表示的Windows中常用的基本類型表基本類型意義byByte字節(jié)fon(fn)Font字體msgMessage消息re(rc)Rectangle矩形sString串scrScreenregion屏幕區(qū)szNULL終正串uUnsignedinteger無符號整數(shù)wWord字wndWindows窗口常用的公共前綴前綴意義a數(shù)組e數(shù)組元素h句柄I數(shù)組元素索引MFC中常用基本類(或結(jié)構(gòu))的前綴前