代码常用后缀命名参考

Jimmy Zhan

发表于2013-06-07 14:13:10

 

1 常见集合类型后缀命名

凡符合下表所列的集合类型,应添加相应的后缀。

说明 后缀 示例
数组 Array int[] productArray
列表 List List<Product> productList
DataTable/HashTable Table HashTable productTable
字典 Dictionary Dictionay<string,string> productDictionary
EF中的DbSet /DataSet Set DbSet<Product> productSet

2 常见后缀命名

凡符合下表所列的局部变量、方法参数、字段、属性,均需添加相应的后缀。

说明 后缀 示例 示例说明
费用相关 Cost ShipCost 运输费
价格相关 Price ProductUnitPrice 产品单价
消息相关 Message(弃用Note) SuccessMessage 成功消息
日期相关 Date(弃用Time) OrderDate 下单日期
计数、数量相关 Count(弃用Time) LoginCount 登录次数
链接地址相关 Url BlogUrl 博客链接
图片相关 Image SignImage 签名图片
金额相关 Amount PrepaidAmount 预付款
点数、积分相关 Point MemberPoint 会员积分
记录、日志相关 Record(弃用Log) ErrorRecord 错误记录
配置相关 Config DataBaseConfig 数据库配置
状态相关 Status OrderStatus 订单状态
模式、方式相关 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连接

3 常见类型命名

凡存在下表中的类型,需采用下表指定的名称命名。

类型 命名 类型 命名
客户 Customer 分销商 Reseller
零售商 Retailer 经销商/批发商 Dealer
用户 UserInfo(User为数据库关键字) 订单 OrderInfo(Order为数据库关键字)
供应商 Supplier 管理员 Admin
密码 Password 会员 Member
评论 Remark(弃用Comment) 文章 Article
新闻 News 发票 Invoice
导入 Import 导出 Export
公司、企业 Company(弃用Enterprise) 产品 Product
省份 Province 城市 City
区县 District 地址 Address
角色 Role(弃用Group) 权限 Authority(弃用Permission)
仓库 Warehouse 工厂 Plant
登录 Login(弃用SignIn) 登出 LogOut(弃用SignOut)
创建 Create(弃用Add) 编辑 Edit
更新 Update 删除 Remove(弃用Delete)
照片 Photo 图片 Image

4 常见字段、属性命名

字段、属性种类比较繁杂,因此仅列出最常用的几项。

类型 名称 类型 名称
Id(int型) Id(“d”小写,弃用ID) GuidId(Guid型) Id
Name 名称 Title 标题
Remark 备注、描述(弃用Memo、Description) Category 种类(弃用Class、Type)
Linkman 联系人    

 

以上内容摘自Jimmy Zhang的“项目代码风格要求”,原文完整地址:http://www.cnblogs.com/JimmyZhang/archive/2013/06/05/3118936.html