軟件開(kāi)發(fā)流程管理規(guī)范(編輯修改稿)
2025-05-06 07:18 本頁(yè)面
【文章內(nèi)容簡(jiǎn)介】 可使用 sb作為前綴開(kāi)頭，后跟變量名駝峰樣式。對(duì)于集合類(lèi)型變量，如數(shù)組、List、Dictionary，可以在變量命名的基礎(chǔ)上結(jié)尾加入集合類(lèi)型簡(jiǎn)寫(xiě)。如，sqlList，dataDic等。命名方法：項(xiàng)目大寫(xiě)首字母+_+功能（全英文大寫(xiě)）【多單詞組成的，取單詞首字母大寫(xiě)組合】表字段：類(lèi)似變量命名索引:表名（或縮寫(xiě)）+_+列名+idx注：ID、創(chuàng)建人（creator）、創(chuàng)建時(shí)間（createTime）、狀態(tài)（state）、創(chuàng)建人工號(hào)（createID）等字段為必須創(chuàng)建的字段。代碼規(guī)范建議每個(gè)模塊中代碼至少分三層結(jié)構(gòu),根據(jù)項(xiàng)目大小決定是否采用這種方式,可以先以一兩個(gè)項(xiàng)目測(cè)試一下這種結(jié)構(gòu)。表現(xiàn)層邏輯層數(shù)據(jù)層
例如一個(gè)項(xiàng)目的一個(gè)模塊，可以創(chuàng)建文件夾結(jié)構(gòu)如下所示：表現(xiàn)層頁(yè)面 *.aspx數(shù)據(jù)層 *.cs邏輯層 *.cs表現(xiàn)層直接面向用戶，邏輯層負(fù)責(zé)后端邏輯處理，數(shù)據(jù)層負(fù)責(zé)和底層數(shù)據(jù)庫(kù)交互。表現(xiàn)層調(diào)用邏輯層代碼，只有查詢(xún)數(shù)據(jù)時(shí)，表現(xiàn)層可以直接調(diào)用數(shù)據(jù)層；邏輯層負(fù)責(zé)處理邏輯，為表現(xiàn)層提供調(diào)用接口，其數(shù)據(jù)操作需要調(diào)用數(shù)據(jù)層提供接口；數(shù)據(jù)層負(fù)責(zé)提供和處理數(shù)據(jù)，需要為邏輯層提供調(diào)用接口，所有與數(shù)據(jù)庫(kù)的操作都只能在該層實(shí)現(xiàn)。a)b)c)d)e)f)g)h)i)j)k)l)類(lèi)功能必須唯一：每個(gè)文件中只有一個(gè)類(lèi)（不包括內(nèi)部類(lèi)）行寬限制在 80個(gè)字符內(nèi)，必須按最低優(yōu)先級(jí)換行方法代碼限制在 200行內(nèi)類(lèi)代碼建議限制在 1500行內(nèi)方法參數(shù)過(guò)長(zhǎng)，應(yīng)分行顯示，逗號(hào)至于末尾每行聲明一個(gè)變量，且盡量賦初值，同類(lèi)型必須連續(xù)寫(xiě)復(fù)合語(yǔ)句都需加大括號(hào){ }，不要寫(xiě)在一行，if、else盡量配對(duì)出現(xiàn)，try、catch、finally高扇入、合理扇出（盡量不超過(guò)三層）縮進(jìn)不允許空行遞歸要慎用，goto不允許使用方法內(nèi)禁止更改傳遞過(guò)來(lái)的參數(shù)實(shí)體類(lèi)中變量應(yīng)私有化，應(yīng)包含每個(gè)變量的 set及 get方法m)避免三層以上嵌套循環(huán)n)o)p)q)r)s)t)u)代碼應(yīng)包含正確性和容錯(cuò)性處理（try、catch、finally）編程時(shí)應(yīng)考慮代碼的效率（時(shí)間、空間），多循環(huán)內(nèi)側(cè)，變量聲明放在循環(huán)外對(duì)象比較用對(duì)應(yīng)方法不用“==”，例如：equals，pare to計(jì)算盡量避免除法設(shè)計(jì)方法可重用性else、finally、catch、日志必須有出口堆常量統(tǒng)一定義，避免用常量字符串變量必須初始化頁(yè)面端JS代碼和 CSS代碼統(tǒng)一放置在 html的 head子元素中；
JS代碼需要有注釋?zhuān)豁?yè)面控件有嵌套情況的，各級(jí)需要縮進(jìn)，并且各級(jí)的頭尾對(duì)齊；頁(yè)面處理類(lèi)頁(yè)面加載時(shí)謹(jǐn)慎處理 Session置空；類(lèi)中多處用到的變量建議創(chuàng)建成員變量，成員變量應(yīng)私有化（private），位于類(lèi)代碼上方；除用于 public外，其他方法建議均為 private；Page_Load方法：建議將頁(yè)面加載方法中內(nèi)容加入if (!){}代碼塊中，避免頁(yè)面每次操作后都調(diào)用 Page_Load方法；獲取頁(yè)面的服務(wù)端控件的值前需對(duì)控件值的 null和空進(jìn)行判斷，避免空指針異常；避免過(guò)多或復(fù)雜的邏輯處理代碼，統(tǒng)一調(diào)用邏輯層代碼，將展現(xiàn)和邏輯分離；對(duì)數(shù)據(jù)的增刪改操作不要直接調(diào)用數(shù)據(jù)層，查詢(xún)可直接調(diào)用數(shù)據(jù)層代碼；除對(duì)表現(xiàn)層提供的接口方法外，其他方法均保持私有 private對(duì)數(shù)據(jù)庫(kù)數(shù)據(jù)處理調(diào)用數(shù)據(jù)處理層代碼對(duì)串行的數(shù)據(jù)處理時(shí)事務(wù)保證邏輯代碼容錯(cuò)性保證除對(duì)外提供的接口方法外，其他方法均保持私有 private對(duì)數(shù)據(jù)庫(kù)的底層訪問(wèn)（獲取數(shù)據(jù)庫(kù)連接、執(zhí)行 sql語(yǔ)句、數(shù)據(jù)庫(kù)連接關(guān)閉）均調(diào)用數(shù)據(jù)庫(kù)操作幫助類(lèi)數(shù)據(jù)處理層類(lèi)中只處理數(shù)據(jù)，避免業(yè)務(wù)邏輯代碼sql語(yǔ)句編寫(xiě)時(shí)避免使用“+”數(shù)據(jù)庫(kù)操作幫助類(lèi)中數(shù)據(jù)庫(kù)操作的容錯(cuò)性和事務(wù)處理（插入、更新、刪除操作需要事務(wù)保證）注釋編寫(xiě)任何代碼都需要有代碼注釋?zhuān)⑶掖a修改后也要修改注釋?zhuān)ＷC代碼注釋同步。在 vs安裝目錄，以下目錄中，找到 ，修改保存后，重啟 vs，之后創(chuàng)建新類(lèi)時(shí)即會(huì)自動(dòng)產(chǎn)生注釋。D:\ProgramFiles(x86)\MicrosoftVisualStudio
\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\但是修改后沒(méi)有效果。創(chuàng)建新對(duì)象可以手工添加注釋?zhuān)鹤⑨寣?xiě)法：塊注釋注釋包含在/*和*/中，可以有多行。行注釋以//開(kāi)頭，可以有多行，每行前面都以//開(kāi)頭。文件頭注釋/* ==============================================================================* Copyright 169。 2013 ECOVACS Inc. All rights reserved!*科沃斯機(jī)器人科技(蘇州)有限公司*=====================================================
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1