研發(fā)代碼編程規(guī)約

1、研發(fā)代碼編程規(guī)約一、數(shù)據(jù)庫連接規(guī)范1. 使用Trycatchfinally，在使用完一個鏈接后務(wù)必關(guān)閉它（在finally塊中關(guān)閉）；2. 使用using釋放資源；3. 盡量減少配置文件的個數(shù)；4. 開發(fā)采用三層或以上結(jié)構(gòu)，及表現(xiàn)層、邏輯層、數(shù)據(jù)層，避免使用數(shù)據(jù)庫直連方式操作數(shù)據(jù)庫；5. 建立獨立的數(shù)據(jù)庫操作類，所有數(shù)據(jù)庫連接、事務(wù)等操作使用此獨立的數(shù)據(jù)庫操作類。二、注釋規(guī)范注釋應(yīng)該增加代碼的清晰度；保持注釋的簡潔，不是任何代碼都需要注釋的，過多的注釋反而會影響代碼的可讀性；注釋不應(yīng)該包括其他的特殊字符；先寫注釋，后寫代碼；注釋規(guī)范包括：模塊類接口注釋規(guī)范、類的屬性、方法注釋規(guī)范。1、模塊類接

2、口注釋規(guī)范模塊類接口開始必須以以下形式書寫模塊注釋：/作用&目的：/作者：作者中文名/編寫日期：/如果模塊類有修改，則每次修改必須添加以下注釋：/Log編號：/修改描述：/作者：修改者中文名/修改日期：/2、類屬性注釋規(guī)范在類的屬性必須以以下格式編寫屬性注釋：/屬性說明/3、方法注釋規(guī)范在類的方法聲明前以以下格式編寫注釋：/說明：/paramname=/注：公有方法必須按照以上格式注釋，私有方法也可用雙反斜杠做簡要注釋。三、錯誤處理和日志記錄不要“捕捉了異常卻什么也不做”。發(fā)生異常時，給出友好的消息給用戶，但要精確記錄錯誤的所有可能細節(jié)，包括發(fā)生的時間，和相關(guān)方法，類名等。別寫太大的try-c

3、atch模塊。如果需要，為每個執(zhí)行的任務(wù)編寫單獨的try-catch模塊。1、日志類型主要分三大類：安全類信息：記錄系統(tǒng)邊界交互行為和信息業(yè)務(wù)類信息：記錄系統(tǒng)內(nèi)部業(yè)務(wù)處理行為和信息性能類信息：記錄系統(tǒng)硬件對業(yè)務(wù)處理的支撐能力2、日志級別ERROR（錯誤）：此級別記錄影響主體系統(tǒng)核心模塊正常工作，需要修復才能正常工作的問題。WARN（警告）：此級別記錄系統(tǒng)一般模塊存在問題，不影響系統(tǒng)運行。包括記錄普通的異常拋出。INFO （通知）：此級別主要是記錄系統(tǒng)運行狀態(tài)等關(guān)聯(lián)信息。包括服務(wù)啟動、服務(wù)停止、用戶登錄、退出、權(quán)限更改、用戶操作申請等信息。DEBUG（調(diào)試）：最細粒度的級別記錄，除卻上面各種情況

4、后，希望輸出的相關(guān)信息，都可以在這里輸出。3、日志記錄準則記錄ERROR、WARN及INFO級別的日志，在日志文件前加入項目名稱前綴縮寫，如“Application_error.log”。DEBUG級別日志在試運行階段需監(jiān)控系統(tǒng)各種操作時可加入記錄。日志記錄使用開源組件，從common.logging，Nlog或Log4net三個日志組件中擇其一。建議使用配置文件定義日志輸出目錄、日志名稱、日志輸出級別等信息。以電子病歷為主的依附產(chǎn)品及功能模塊，日志文件放入電子病歷根目錄；其它獨立產(chǎn)品可放入該產(chǎn)品獨立目錄。日志內(nèi)容格式建議：記錄時間：yyyy-MM-dd HH:mm:ss 記錄等級：ERROR 出錯類：perty:(null) 錯誤描述：發(fā)生了一個異常XXXX四、評審檢查每月進行一次代碼檢查，主要是抽查各產(chǎn)品組代碼中的注釋，進行評審。