說明 | 后綴 | 示例 |
數(shù)組 | Array | int[] productArray |
列表 | List | ListProduct> productList |
DataTable/HashTable | Table | HashTable productTable |
字典 | Dictionary | Dictionaystring,string> productDictionary |
EF中的DbSet /DataSet | Set | DbSetProduct> productSet |
1.19 常見后綴命名
凡符合下表所列的局部變量、方法參數(shù)、字段、屬性,均需添加相應的后綴。
說明 | 后綴 | 示例 | 示例說明 |
費用相關 | Cost | ShipCost | 運輸費 |
價格相關 | Price | ProductUnitPrice | 產(chǎn)品單價 |
消息相關 | Message(棄用Note) | SuccessMessage | 成功消息 |
日期相關 | Date(棄用Time) | OrderDate | 下單日期 |
計數(shù)、數(shù)量相關 | Count(棄用Time) | LoginCount | 登錄次數(shù) |
鏈接地址相關 | Url | BlogUrl | 博客鏈接 |
圖片相關 | Image | SignImage | 簽名圖片 |
金額相關 | Amount | PrepaidAmount | 預付款 |
點數(shù)、積分相關 | Point | MemberPoint | 會員積分 |
記錄、日志相關 | Record(棄用Log) | ErrorRecord | 錯誤記錄 |
配置相關 | Config | DataBaseConfig | 數(shù)據(jù)庫配置 |
狀態(tài)相關 | Status | OrderStatus | 訂單狀態(tài) |
模式、方式相關 | Mode | OpenMode | 打開方式 |
種類相關 | Category / Type 二選一 | UserCategory | 用戶種類 |
工廠類相關 | Factory | ConnectionFactory | 連接工廠 |
啟用相關 | Enabled | ExportEnabled | 開啟導出 |
流相關 | Stream | UploadStream | 上傳流 |
讀取器相關 | Reader | ExcelReader | Excel讀取器 |
寫入器相關 | Writer | ExcelWriter | Excel寫入器 |
適配器相關 | Adapter | IntroOPAdapter | IntroOP適配器 |
提供器相關 | Provider | MemebershipProvider | 會員信息提供器 |
包裝器相關 | Wrapper | ProductWrapper | Product包裝器 |
連接相關 | Connection | ExcelConnection | Excel連接 |
1.20 常見類型命名
凡存在下表中的類型,需采用下表指定的名稱命名。
類型 | 命名 | 類型 | 命名 |
客戶 | Customer | 分銷商 | Reseller |
零售商 | Retailer | 經(jīng)銷商/批發(fā)商 | Dealer |
用戶 | UserInfo(User為數(shù)據(jù)庫關鍵字) | 訂單 | OrderInfo(Order為數(shù)據(jù)庫關鍵字) |
供應商 | Supplier | 管理員 | Admin |
密碼 | Password | 會員 | Member |
評論 | Remark(棄用Comment) | 文章 | Article |
新聞 | News | 發(fā)票 | Invoice |
導入 | Import | 導出 | Export |
公司、企業(yè) | Company(棄用Enterprise) | 產(chǎn)品 | Product |
省份 | Province | 城市 | City |
區(qū)縣 | District | 地址 | Address |
角色 | Role(棄用Group) | 權限 | Authority(棄用Permission) |
倉庫 | Warehouse | 工廠 | Plant |
登錄 | Login(棄用SignIn) | 登出 | LogOut(棄用SignOut) |
創(chuàng)建 | Create(棄用Add) | 編輯 | Edit |
更新 | Update | 刪除 | Remove(棄用Delete) |
照片 | Photo | 圖片 | Image |
1.21 常見字段、屬性命名
字段、屬性種類比較繁雜,因此僅列出最常用的幾項。
類型 | 名稱 | 類型 | 名稱 |
Id(int型) | Id(“d”小寫,棄用ID) | GuidId(Guid型) | Id |
Name | 名稱 | Title | 標題 |
Remark | 備注、描述(棄用Memo、Description) | Category | 種類(棄用Class、Type) |
Linkman | 聯(lián)系人 |
2. XHTML 代碼風格要求2.1 如果XHTML標記有層次,那么代碼也要有層次
下面是書寫符合要求的例子:
下面是書寫 不符合要求 的例子:
2.2 所有標記必須閉合
示例代碼如下:
2.3 如果標記中間代碼超過20行,則應在標記末尾加注標識
標注方式如下:
3. CSS 代碼風格要求3.1 代碼使用半展開
設置方法參考1.4節(jié)。
3.2 使用Tab作為縮進,并設置縮進大小為4
設置方法參考1.5節(jié)。
3.3 代碼注釋
注釋主要說明該樣式應用于頁面的哪個部分,而非說明樣式的應用效果,代碼注釋風格如下所示:
3.4 代碼編寫
每一個樣式設置必須獨占一行,不能位于同一行,下面是符合要求的寫法:
下面是 不符合要求 的寫法:
3.5 嵌入式樣式的比例不超過樣式表代碼總量的10%
嵌入式樣式為直接寫在HTML標記內(nèi)部的樣式,如下圖所示:
3.6 內(nèi)聯(lián)式樣式的比例不超過樣式表代碼總量的30%
內(nèi)聯(lián)式樣式為寫在head>/head>中的樣式,如下圖所示:
內(nèi)聯(lián)式樣式,不能 寫在body>/body>之間。
3.7 外聯(lián)式樣式表的比例不少于樣式表代碼總量的60%
外聯(lián)式樣式表為寫在.css文件中的樣式,通過link引入到XHTML頁面中,如下圖所示:
4. JavaScript 代碼風格要求4.1 代碼使用半展開
設置方法參考1.4節(jié)。
4.2 使用Tab作為縮進,并設置縮進大小為4
設置方法參考1.5節(jié)。
4.3 代碼注釋
代碼注釋需要說明“函數(shù)功能”、“入口參數(shù)”、“返回值”,注釋范例如下:
其中第一行說明函數(shù)功能;第二行說明入口參數(shù);最后一行說明返回值
4.4 不得出現(xiàn)內(nèi)嵌式代碼
內(nèi)嵌式代碼是指寫在XHTML標記中的JavaScript代碼,下面的寫法是 不符合要求 的:
4.5 內(nèi)聯(lián)式代碼占JavaScript的總量不得超過40%
內(nèi)聯(lián)式代碼是指寫在head />或者body />之間的代碼:
4.6 外聯(lián)式代碼占JavaScript的總量至少為60%
外聯(lián)式代碼指寫在單獨的.js文件中,然后通過script標記連接到XHTML頁面中的代碼。
感謝閱讀,希望這篇文章能給你帶來幫助!