【正文】 // + Password CString strWrkStr = sWrkBankCode + sWrkPassword。 // 考慮到要添加回車換行，多分配點空間 char * p = (nOutLen)。 // 輸出的行長度計數(shù) if(bResetLineChars){ // 行計數(shù)復(fù)位 nLineChars = 0。return。放置在語句右側(cè)的注釋垂直方向盡量對齊，縮進位置與語句塊相同。通過語句塊注釋，應(yīng)能反映程序功能的概貌，注釋量不應(yīng)少于該模塊概要設(shè)計的流程描述量。, BOOL, int, int)。如該函數(shù)或方法沒有重載，則不必使用參數(shù)列表，如 GetTag()。? 需要特別說明一段文字，可以使用 code/endcode。通過變更基數(shù)或位數(shù)，本類理論上可以處理的任意整數(shù)。如果計算機字長為 32 位，則最大可以表示的整數(shù)為 4294967296. br * 為了突破計算機最大整數(shù)的限制，可以采取兩種做法，一是擴大基數(shù)，二是增加字長。? 文檔注釋中可以使用par 增加一個小節(jié)，靈活使用此標(biāo)記可以任意地擴展文檔的結(jié)構(gòu)，滿足特殊描述的需要。 */? 注釋中可使用 HTML 標(biāo)記美化最終文檔，但別濫用美化標(biāo)記；16 / 95? 較長的文檔注釋需要分段說明時，使用br分段。其中除正文體外，其余各塊都是定長的； * 正文體由一個或多個業(yè)務(wù)塊組成。 */define SHORT_MSGBODY_MAX_LEN 1000000 文檔注釋技巧建議 4: 為使 doxygen 工具能生成更好的文檔，編寫文檔注釋時參考下列技巧：?注釋中使用的標(biāo)識符前后均應(yīng)留一個空格，以便 doxygen 識別此標(biāo)識符，并自動生成一個引用連接。* * 此長度應(yīng)根據(jù) MQCMT 類定義最大消息長度進行調(diào)整，超過此長度的報文應(yīng)分為多個報文片斷傳輸。特別重要的宏可以使用與類相同的文檔注釋。}。 char finalMark[1]。 char reserve[20]。 char mesgPRI[1]。 char deliTime[6]。 char expTime[4]。 char sentTime[14]。 char workDate[8]。 char mesgReqNo[REQUESTID_LEN]。 char mesgID[MSGID_LEN]。 char outForm[1]。 char mesgPurp[1]。 char destAddr[12]。 char startAddr[12]。 char appTradeCode[8]。 char mesgLen[6]。 char verID[1]。*/struct CMTHeaderMap { char blockMark[3]。 /// 批量業(yè)務(wù)頭對象} 結(jié)構(gòu)注釋規(guī)則 23: 結(jié)構(gòu)可使用簡單注釋，也可使用與類相同的注釋格式，其數(shù)據(jù)成員使用斷行注釋。 /// 報頭對象 CMTMsgTail m_Tail。 /// 文件型報文的文件名 CString m_strBody。注釋格式如下：例：class CMTMsg{…private: BOOL m_bBodyInFile。 */CString BuildAuthStr(LPCSTR sBankCode, LPCSTR sPassword)。 * return 身份認(rèn)證串。如：例：/** * brief 根據(jù)行號與密碼生成報尾校驗碼作為身份認(rèn)證串。 * if(nRetCode 0) { ...Fail ... } * endcode */ int AddToSet(sigset_t* stSet, int nSignal, int nOtherSignal = 0, ...)。 * if(nRetCode 0) { ...Fail ... } * ... * nRetCode = (amp。 * warning 如果添加多個信號時沒有使用 0 作結(jié)束，則程序可能異常中止！ * see DelFromSet()、AddAllToSet()、ClearSet() * * par 使用范例: * code * int nRetCode = (amp。 * return 添加失敗返回負(fù)整數(shù)，失敗原因可以從 errno 獲取。 * warning 警告信息* deprecated 函數(shù)即將失效警告* see 引用說明 * * par 使用范例: * code * 例子程序 * endcode ** par 算法或流程說明:* 詳細(xì)算法或流程說明* * par 變更歷史： * 時間 作者 修改說明 */例：/** * brief 添加一個或多個信號到信號集合。13 / 95 * * note 函數(shù)功能詳細(xì)說明。 * return 返回值說明 * 返回值 1 返回值 1 說明； * 返回值 2 返回值 2 說明。 */class CSignal{ …} 函數(shù)或方法注釋規(guī)則 21: 函數(shù)或方法注釋放置在其聲明前，主要介紹函數(shù)的功能、參數(shù)、返回值、異常、使用說明、范例、引用關(guān)系、變更信息等信息。br * 本類主要提供下列三類方法： * 信號集合管理，提供信號集合的添加、刪除、判斷功能； * 信號句柄管理，提供設(shè)置與獲取信號處理函數(shù)功能； * 信號處理，設(shè)置與獲取阻塞信號集、發(fā)送信號、等待信號功能。 類注釋規(guī)則 20: 類注釋放置在類聲明前，主要介紹類的功能及相關(guān)說明。** par 版權(quán)信息：* Copyright(C) 20222022 CNCC/CDC*/注：粗體字為需定制化的內(nèi)容；蘭色字為可選的內(nèi)容，如果沒有這些內(nèi)容，請刪除。br * 本類主要提供下列三類方法： * 信號集合管理，提供信號集合的添加、刪除、判斷功能； * 信號句柄管理，提供設(shè)置與獲取信號處理函數(shù)功能； * 信號處理，設(shè)置與獲取阻塞信號集、發(fā)送信號、等待信號功能。 文檔化注釋 文件注釋規(guī)則 19: 文件注釋放置在文件頭部，主要包括此文件的功能說明，編寫人和修改人以及編寫和修改的日期，版權(quán)聲明，版本等信息，應(yīng)盡量使用中文。void HexToBin(LPCSTR sInStr ,BYTE * psOutStr,ULONG * plRetSize = NULL)。 參數(shù)命名建議 2: 函數(shù)或方法的參數(shù)命名參考變量命名，但應(yīng)使用 In，Out、Ret 等簡寫修飾參數(shù)，增加函數(shù)聲明的可讀性。10 / 95建議 1: 不應(yīng)在函數(shù)名中使用數(shù)字，如：GetName1()，Kill2()。如：GetName()，StrTrimLeft()，KillProc()。如：CSignal，CFile，CString，CTagMgr。如：ifndef __CSIGNAL_HPP__define __CSIGNAL_HPP__…endififndef __CSIGNAL_H__define __CSIGNAL_H__…endif 類命名規(guī)則 16: 類命名應(yīng)使用字符 C|T＋名稱形式。define E_FILE_NOTFOUND 61101001 /// 文件不存在!define E_DB_SELECT_FAIL 62301050 /// 選取數(shù)據(jù)庫失敗!define E_SYS_INVALID_STATUS 62301001 /// 系統(tǒng)狀態(tài)非法!規(guī)則 14: 作為編譯條件的宏，應(yīng)使用_NAME_形式。常用前綴符前綴符 含義 例子g_ 全局變量 g_stSystem, g_cMacType， g_strSysNames_ 靜態(tài)變量 s_nCurCnt，s_strStaticName，s_pSysTimem_ 類數(shù)據(jù)成員 m_nBankType，m_sWrkBuffer, m_strMyNameh 句柄類變量 hnFileHandle，hnSocket，hpProcHandlep 指針類變量 psReadBuff，pstrRetStr，ppTargeta 數(shù)組類變量 anPorts，asSendBuffers，apWrkBuffs常用基本類型符前綴符 含義 例子b bool bOK，bQuit，bFindc、ch char cFlag，cBankType，chSubSystemTypes char [] sSysName，sStaticName，sTimeStrstr CString、String strSysName, strStaticName, strTimeStrby unsign char [] byMacStr，bySendBuffer, bySrcBuffern、i int nCnt，nPort，nRetCodel long lFileSize，lOffset，lCountd double dAmount，dSumVal，dWrkValf float fAmount, fSumVal, fWrkValui/ul unsigned int/long uiCnt, uiFileSize, ulRetCountw WORD 與 unsigned int 等價的 32 位整數(shù)dw DOUBLE WORD 與 unsigned long 等價的 64 位整數(shù)9 / 95em 枚舉型變量 emDays, emColors, emSetst 結(jié)構(gòu)型編碼 stSystem，stCtrlData, stSet規(guī)則 11: 禁止使用單字母作為變量名。 變量命名規(guī)則 10: 變量命名主要采用匈牙利命名法，格式為[作用域范圍前綴_][前綴]基本類型＋名稱。 文件命名規(guī)則 9: 文件命名應(yīng)使用模塊名的小寫字母形式。規(guī)則 8: 名稱太長超過 15 字符時應(yīng)使用簡稱。此時，應(yīng)創(chuàng)建一個編譯全部子系統(tǒng)的編譯文件或腳本放置到 src 目錄。W o r k D i r e c t o r ys r cs o u r c em a k e f i l e* . c p p* . ci n c l u d e* . h p p* . hr e lb i nl i b7 / 95規(guī)則 5: 復(fù)雜應(yīng)用應(yīng)分子系統(tǒng)創(chuàng)建目錄結(jié)構(gòu)，模塊程序代碼應(yīng)分別放置到src/module/include 目錄與 src/module/source 目錄，應(yīng)用編譯文件放置到 src 目錄，編譯后的可執(zhí)行文件放置到 rel/bin 目錄，靜態(tài)庫或動態(tài)庫放置到 rel/lib 目錄。 }}return TRUE。 ii strlen(sInStr)。例：static BOOL IsChineseChar(const char* s){ ……。下例中 IsChineseChar()是內(nèi)部使用的函數(shù)，不提供給外部應(yīng)用使用，因此不能在 中增加聲明。禁止將功能關(guān)聯(lián)松散的多個類，放置到一個模塊中。C++ 做擴展名， 做擴展名；C 做擴展名， 做擴展名。規(guī)范文本分為規(guī)則與建議兩種，其中規(guī)則是強制執(zhí)行的條款，建議則由程序員根據(jù)實際情況靈活掌握。為規(guī)范編碼行為，增強程序代碼的可讀性、可維護性，提高編碼質(zhì)量與效率，保障應(yīng)用軟件產(chǎn)品整體品質(zhì)與可持續(xù)開發(fā)性，特制定本規(guī)范。每個程序員都有自己的編碼經(jīng)驗與風(fēng)格，如果缺乏統(tǒng)一的編程規(guī)范，則可能導(dǎo)致軟件產(chǎn)品最終程序代碼風(fēng)格迥異，可讀性與可維護性均較差，不僅給程序代碼的理解帶來障礙，也增加維護階段的工作量。軟軟軟 件件件 編編編 碼碼碼 規(guī)規(guī)規(guī) 范范范文件編號： RDCDEDSCSSPC00當(dāng)前版本：作 者：審 核 人：文件狀態(tài)：[√] 草稿[ ] 正式發(fā)布[ ] 正在修改完成日期：中國人民銀行清算總中心支付系統(tǒng)開發(fā)中心文檔修訂記錄2 / 95版本編號 變化狀態(tài) 簡要說明 日期 變更人 批準(zhǔn)日期 批準(zhǔn)人注：變化狀態(tài)： A—增加， M—修改， D—刪除3 / 95 目 錄第一篇 C/C++編碼規(guī)范 ..............................................................6第一章 代碼組織 ................................................................6第二章 命名 ....................................................................9 文件命名 ................................................................9 變量命名 .................................................