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