程序代码规范.docx
- 文档编号:9422775
- 上传时间:2023-05-19
- 格式:DOCX
- 页数:11
- 大小:139.77KB
程序代码规范.docx
《程序代码规范.docx》由会员分享,可在线阅读,更多相关《程序代码规范.docx(11页珍藏版)》请在冰点文库上搜索。
程序代码规范
代码规范V1.0
目录
代码规范V1.01
1.C#代码风格要求2
1.1注释2
1.2命名3
1.2.1通用命名规范3
1.2.2文件命名规范3
1.2.3命名空间,类,函数命名规范3
1.2.4变量命名规范4
1.2.5委托和事件的命名5
1.3其他规范6
1.4常见集合类型后缀命名7
1.4.1所列的集合类型,应添加相应的后缀。
7
1.4.2常见后缀命名(仅供参考)7
1.4.3常见类型命名(仅供参考)9
1.4.4常见字段、属性命名(仅供参考)9
2.数据库代码风格要求10
1.C#代码风格要求
1.1注释
类型、属性、事件、方法、方法参数,根据需要添加注释。
如果类型、属性、事件、方法、方法参数的名称已经是自解释了,则不需要加注释;否则必须添加注释。
当添加注释时,添加方式如下图所示:
1.2命名
1.2.1通用命名规范
1.2.1.1命名优先考虑英文
如果英文没有合适的单词描述,可以使用拼音。
1.2.1.2不使用缩写
所有类型、方法、参数、变量的命名不得使用缩写,包括大家熟知的缩写,例如msg、pr等。
1.2.2文件命名规范
1.2.2.1一个.cs源文件至多定义两个类型。
1.2.2.2类型名称和源文件名称必须一致
当类型命名为Product时,其源文件命名只能是Product.cs。
1.2.3命名空间,类,函数命名规范
1.2.3.1所有命名空间,类型名称,函数使用Pascal风格(单词首字母大写)
如下图所示,红色标记的为使用Pascal风格的类型:
注意ProductType是私有类型,不管类型是公有的还是私有的,其命名总是采用Pascal风格。
1.2.3.4返回bool类型的方法、属性的命名
如果方法返回的类型为bool类型,则其前缀为Is、Can或者Try,例如:
1.2.4变量命名规范
1.2.4.1参数名称使用Camel风格(首字母小写,其后每个单词的首字母大写)。
自定义数据类型中的成员名称命名方式与数据库命名保持一至。
红色标记的为使用Camel风格的变量或者方法参数:
1.2.4.2型内部的私有和受保护字段,使用Camel风格命名,但加“_”前缀
代码示例如下:
1.2.5委托和事件的命名
委托以EventHandler作为后缀命名,例如SalesOutEventHandler。
事件以其对应的委托类型,去掉EventHandler后缀,并加上On前缀构成。
例如,对于SalesOutEventHandler委托类型的事件,其事件名称为:
OnSalesOut。
示例代码如下:
1.3其他规范
1.3.1不能出现公有字段
如果需要公有字段,使用属性进行包装。
1.3.2类型成员的排列顺序
类型成员的排列顺序自上而下依次为:
字段:
私有字段、受保护字段
属性:
私有属性、受保护属性、公有属性
事件:
私有事件、受保护事件、公有事件
构造函数:
参数数量最多的构造函数,参数数量中等的构造函数,参数数量最少的构造函数
方法:
重载方法的排列顺序与构造函数相同,从参数数量最多往下至参数最少。
1.3.3其他成员,需加this;调用父类成员,需加base
示例代码如下:
1.4常见集合类型后缀命名
1.4.1所列的集合类型,应添加相应的后缀。
说明
后缀
示例
数组
Array
int[]productArray
列表
List
List
DataTable/HashTable
Table
HashTableproductTable
字典
Dictionary
Dictionay
EF中的DbSet/DataSet
Set
DbSet
1.4.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连接
1.4.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
1.4.4常见字段、属性命名(仅供参考)
字段、属性种类比较繁杂,因此仅列出最常用的几项。
类型
名称
类型
名称
Id(int型)
Id(“d”小写,弃用ID)
Guid(Guid型)
Id
Name
名称
Title
标题
Remark
备注、描述(弃用Memo、Description)
Category
种类(弃用Class、Type)
Linkman
联系人
2.数据库代码风格要求
2.1数据表命名规范,前缀_表名[_后缀]
2.1.1首选英文单词,没有合适的单词时选择拼音.
2.1.2前缀使用模块名缩写,例如客户CM(Custom)、产品PR(Product)、系统SYS(System),无合适前缀时用小写t代替(表示Table)。
2.1.3后缀一般用于区分多个关系紧密的表,例如BC_Area_Province,BC_Area_City,BC_Area_District,BC_Area_Road,不需要后缀区分时可以省略。
2.2存储过程命名规则,前缀_名称_后缀
2.2.1前缀使用SP(storedprocedure),大写SP是为区分系统存储过程和自定义存储过程,SQLSERVER中不分大小写,起名时应注意重复。
2.2.2名称使用模块名称或者缩写例如Report或RPT
2.2.3后缀使用具体功能名称。
例如:
SP_Report_ChargeDaily
2.3字段名,字段名应避免使用系统关键字,在字段名前应增加前缀,前缀不使用元音字母,推荐大写F,使用这个字符开头几乎不会遇到冲突。
2.3.1字段名以英文单词首选,没有合适单词时可选择拼音。
单词首字母大写。
例如:
FProductName,FQualityGuaranteePeriod
2.3.1自增字段命名为id小写,一个表只能有一个自增段.
2.3.2主键尽量不要设置在非数字类型的字段上.
2.3.3尽量少做表间约束和关联,特别是关联更新和删除.
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 程序代码 规范