最新軟件詳細(xì)設(shè)計文檔模板最全面-資料下載頁
2025-08-01 19:36本頁面
【正文】 詳細(xì)請參見《》178。 這里只做簡單闡述，如有變動，會及時同事整個項目組相關(guān)人員。(1) 不要給類名加前綴。使用PascalCasing風(fēng)格，不使用匈牙利命名法 。 (2) 要用名詞詞組來給類型命名。使用PascalCasing風(fēng)格 。 (3) 類名少用縮寫,不要使用下劃線字符 (_)。 (4) 基類CBase的文件名為：。(5) 泛型類命名：考慮用T來命名參數(shù)類型 ，類如：public class ListT。(6) 接口（Interface）命名規(guī)范和類命名規(guī)范相同，唯一區(qū)別是 接口在名字前加上“I”前綴。(7) 枚舉命名：以復(fù)數(shù)結(jié)尾，表明這是一個枚舉，例如：Enum ColorButtons (8) 結(jié)構(gòu)命名：表明這是一個結(jié)構(gòu)體，例如：Structure CustomerInfoRecord 39。以Record結(jié)尾178。 除使用工具直接生成的類外，其它所有類的功能要有注釋，即使只是一個數(shù)據(jù)對象；非常見功能的API必須要有功能描述的注釋。獨立的要被應(yīng)用其他功能所調(diào)用的模塊的接口和公共API的注釋要完備，即包括功能說明、參數(shù)和返回值說明。其它情況的API的注釋盡量完備，但不強制要求。178。 一次性的流打開后必須關(guān)閉和釋放。一般地，在流打開后，都有一個try catch語句，務(wù)必加上finally塊釋放流資源。178。 即使IF，While是單語句，也要使用“{ }”來劃分程序塊。178。 不要有完全為調(diào)試使用的日志信息，(“1”)；如要使用，在調(diào)試完成后請及時刪除。178。 一些常識性代碼，不需要寫沒必要的注釋。178。 不要用工具生成沒用的注釋。 代碼目錄結(jié)構(gòu)系統(tǒng)架構(gòu)目錄結(jié)構(gòu)設(shè)計圖,如下：結(jié)構(gòu)說明：作用范圍包名描述整個程序ContentImages存放圖片ScriptsJquery以及樣式表等Scripts/jqueryeasyui包數(shù)字為版本Scripts/jqueryui 包數(shù)字為版本Scripts/jthokui自定義的js格式文件Scripts/themesIcon格式圖片以及樣式Controllers../Controller控制器處理來自瀏覽器的輸入，并返回相應(yīng)頁面給用戶。 Data../Data放自定義的json文件Models../Models存放模型Scripts../Scripts引入的各種外部js文件Views../Views存放各種類型的試圖../注意定義路由規(guī)則等../配置文件
環(huán)評公示相關(guān)推薦
鄂ICP備17016276號-1