c代碼編寫規(guī)范標(biāo)準(zhǔn)(已修改)
2025-04-19 05:20 本頁(yè)面
【正文】 . . . .. .代碼編寫規(guī)范(C+數(shù)據(jù)庫(kù))1. 目的 32. 范圍 33. 注釋規(guī)范 3 概述 3 自建代碼文件注釋 3 模塊（類）注釋 4 類屬性注釋 5 方法注釋 5 代碼間注釋 54 命名總體規(guī)則 55 命名規(guī)范 6 變量（Variable）命名 6 常量命名 8 類（Class）命名 8 接口（Interface）命名 8 方法（Method）命名 8 命名空間（NameSpace）命名 96 編碼規(guī)則 9 錯(cuò)誤檢查規(guī)則 9 大括號(hào)規(guī)則 9 縮進(jìn)規(guī)則 9 小括號(hào)規(guī)則 10 if else規(guī)則 10 比較規(guī)則 10 case規(guī)則 10 對(duì)齊規(guī)則 10 單語(yǔ)句規(guī)則 11 單一功能規(guī)則 11 簡(jiǎn)單功能規(guī)則 11 明確條件規(guī)則 11 選用false規(guī)則 11 獨(dú)立賦值規(guī)則 11 定義常量規(guī)則 12 模塊化規(guī)則 12 交流規(guī)則 127 編程準(zhǔn)則 12 12 數(shù)據(jù)庫(kù)操作 12 對(duì)象使用 12 模塊設(shè)計(jì)原則 12 結(jié)構(gòu)化要求 13 函數(shù)返回值原則 138 代碼包規(guī)范 13代碼包的版本號(hào) 13 代碼包的標(biāo)識(shí) 149 代碼的控制 14 14 1510 輸入控制校驗(yàn)規(guī)則 15 15 數(shù)據(jù)錄入控制 1511 數(shù)據(jù)庫(kù)命名規(guī)則 1511．1 數(shù)據(jù)庫(kù)表 1511．2 表字段 1611．3 索引 1611．4 關(guān)聯(lián) 1611．5 儲(chǔ)存過程 16附：變量命名規(guī)范 16附： 2003控件命名規(guī)范 17附： 2005控件命名規(guī)范 181. 目的為了統(tǒng)一公司軟件開發(fā)的設(shè)計(jì)過程中關(guān)于代碼編寫時(shí)的編寫規(guī)范和具體開發(fā)工作時(shí)的編程規(guī)范，保證代碼的一致性，便于交流和維護(hù)，特制定此規(guī)范。2. 范圍本規(guī)范適用于開發(fā)組全體人員，作用于軟件項(xiàng)目開發(fā)的代碼編寫階段和后期維護(hù)階段。3. 注釋規(guī)范 概述a) 注釋中，應(yīng)標(biāo)明對(duì)象的完整的名稱及其用途，但應(yīng)避免對(duì)代碼過于詳細(xì)的描述。b) 每行注釋的最大長(zhǎng)度為100個(gè)字符。c) 將注釋與注釋分隔符用一個(gè)空格分開。d) 不允許給注釋加外框。e) 編碼的同時(shí)書寫注釋。f) 重要變量必須有注釋。g) 變量注釋和變量在同一行，所有注釋必須對(duì)齊，與變量分開至少兩個(gè)“Tab”鍵。如：int iLevel, iCount。 // iLevel ....tree level // iCount ....count of tree items string strSql。 //SQLh) 典型算法必須有注釋。i) 在循環(huán)和邏輯分支地方的上行必須就近書寫注釋。j) 程序段或語(yǔ)句的注釋在程序段或語(yǔ)句的上一行k) 在代碼交付之前，必須刪掉臨時(shí)的或無關(guān)的注釋。l) 為便于閱讀代碼，每行代碼的長(zhǎng)度應(yīng)少于100個(gè)字符。 自建代碼文件注釋對(duì)于自己創(chuàng)建的代碼文件（如函數(shù)、腳本），在文件開頭，一般編寫如下注釋：/****************************************************** FileName:Copyright (c) 2004xxxx *********公司技術(shù)開發(fā)部Writer:Create Date:Rewriter:Rewrite Date:Impact:Main Content（Function Name、parameters、returns） ******************************************************/ 模塊（類）注釋模塊開始必須以以下形式書寫模塊注釋：///summary///Module ID：模塊編號(hào)，可以引用系統(tǒng)設(shè)計(jì)中的模塊編號(hào)///Depiction：對(duì)此類的描述，可以引用系統(tǒng)設(shè)計(jì)中的描述///Author：作者中文名///Create Date：模塊創(chuàng)建日期，格式：YYYYMMDD////summary如果模塊只進(jìn)行部分少量代碼的修改時(shí)，則每次修改須添加以下注釋：///Rewriter：Rewrite Date：修改日期，格式：YYYYMMDD Start1： /* 原代碼內(nèi)容*////End1： 將原代碼內(nèi)容注釋掉，然后添加新代碼使用以下注釋：///Added by：Add date：添加日期，格式：YYYYMMDD Start2： 新代碼內(nèi)容///End2： 如果模塊輸入輸出參數(shù)或功能結(jié)構(gòu)有較大修改，則每次修改必須添加以下注釋：///summary///Log ID：Log編號(hào),從1開始一次增加///depiction：對(duì)此修改的描述///Writer：修改者中文名///Rewrite Date：模塊修改日期，格式：YYYYMMDD////summary 類屬性注釋在類的屬性必須以以下格式編寫屬性注釋：/// summary/// Properties depiction/// /summary 方法注釋在類的方法聲明前必須以以下格式編寫注釋 /// summary /// depiction：對(duì)該方法的說明 /// /summary /// param name=參數(shù)名稱參數(shù)說明/param /// returns
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1