创新互联--领先互联网品牌服务商,十年专业互联网软件开发。
网上订单    付款方式   
钟祥创新互联业务电话
 
  客户服务中心
客户服务: 
客户服务: 
技术支持: 
 
  成功案例
 
 
  您当前的位置 > 技术文档 > 显示正文
项目代码风格要求
作者:创新互联   发布时间:2015/11/2 16:40:41   阅读次数:2628

项目代码风格要求

PDF版下载:项目代码风格要求V1.0.pdf

代码风格没有正确与否,重要的是整齐划一,这是我拟的一份《项目代码风格要求》,供大家参考。

1. C# 代码风格要求

1.1注释

类型、属性、事件、方法、方法参数,根据需要添加注释。

如果类型、属性、事件、方法、方法参数的名称已经是自解释了,则不需要加注释;否则必须添加注释。

当添加注释时,添加方式如下图所示:

1.2 类型(类、结构、委托、接口)、字段、属性、方法、事件的命名

优先考虑英文,如果英文没有合适的单词描述,可以使用拼音,使用中文是不符合要求的。

唯一可以使用中文的地方是枚举的枚举项,枚举项实际已经不属于本节标题的范畴了。这里只是放到一起说明,如下图所示:

1.3 不使用缩写

所有类型、方法、参数、变量的命名不得使用缩写,包括大家熟知的缩写,例如msg。

1.4 代码使用半展开

第一步,打开Visual Studio,进入“工具”,“选项...”,如下图所示:

第二步,进入“文本编辑器”,“C#”,“格式设置”,“新行”,取消掉右侧所有复选框中的对号,如下图所示:

第三步,点击“确定”,完成设置。

1.5 使用Tab作为缩进,并设置缩进大小为4

第一步,打开Visual Studio,进入“工具”,“选项...”,如下图所示:

第二步,进入“文本编辑器”,“C#”,“制表符”,如下图所示,设置制表符。

第三步,点击“确定”,完成设置。

1.6 一个.cs源文件至多定义两个类型

如果两个类型的关系是紧密相关的,比如 产品、产品类型,此时Product类,和ProductType枚举可以定义在同一个Product.cs文件中。

但不能在一个.cs文件中出现两个不相关的类型定义,例如将 Product类和Reseller类(分销商)定义在一个BasicInfo.cs文件中。

1.7 类型名称和源文件名称必须一致

当类型命名为Product时,其源文件命名只能是Product.cs。

1.8 所有命名空间、类型名称使用Pascal风格(单词首字母大写)

如下图所示,红色标记的为使用Pascal风格的类型:

注意ProductType是私有类型,不管类型是公有的还是私有的,其命名总是采用Pascal风格。

1.9 本地变量、方法参数名称使用Camel风格(首字母小写,其后每个单词的首字母大写)

红色标记的为使用Camel风格的变量或者方法参数:

1.10 私有方法、受保护方法,仍使用Pascal风格命名

示例代码如下:

1.11 如果if语句内容只有一行,可以不加花括号,但是必须和if语句位于同一行

范例1.9 中的if判断实际上与下面的语句是等效的:

1.12 调用类型内部其他成员,需加this;调用父类成员,需加base

示例代码如下:

1.13 类型内部的私有和受保护字段,使用Camel风格命名,但加“_”前缀

代码示例如下:

1.14 不能出现公有字段

如果需要公有字段,使用属性进行包装。

1.15 类型成员的排列顺序

类型成员的排列顺序自上而下依次为:

字段:私有字段、受保护字段

属性:私有属性、受保护属性、公有属性

事件:私有事件、受保护事件、公有事件

构造函数:参数数量最多的构造函数,参数数量中等的构造函数,参数数量最少的构造函数

方法:重载方法的排列顺序与构造函数相同,从参数数量最多往下至参数最少。

1.16 委托和事件的命名

委托以EventHandler作为后缀命名,例如 SalesOutEventHandler。

事件以其对应的委托类型,去掉EventHandler后缀,并加上On前缀构成。

例如,对于SalesOutEventHandler委托类型的事件,其事件名称为:OnSalesOut。

示例代码如下:

1.17 返回bool类型的方法、属性的命名

如果方法返回的类型为bool类型,则其前缀为Is、Can或者 Try,例如:

1.18 常见集合类型后缀命名

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

说明后缀示例
数组Arrayint[] productArray
列表ListList<Product> productList
DataTable/HashTableTableHashTable productTable
字典DictionaryDictionay<string,string> productDictionary
EF中的DbSet /DataSetSetDbSet<Product> productSet

1.19 常见后缀命名

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

说明后缀示例示例说明
费用相关CostShipCost运输费
价格相关PriceProductUnitPrice产品单价
消息相关Message(弃用Note)SuccessMessage成功消息
日期相关Date(弃用Time)OrderDate下单日期
计数、数量相关Count(弃用Time)LoginCount登录次数
链接地址相关UrlBlogUrl博客链接
图片相关ImageSignImage签名图片
金额相关AmountPrepaidAmount预付款
点数、积分相关PointMemberPoint会员积分
记录、日志相关Record(弃用Log)ErrorRecord错误记录
配置相关ConfigDataBaseConfig数据库配置
状态相关StatusOrderStatus订单状态
模式、方式相关ModeOpenMode打开方式
种类相关Category / Type 二选一UserCategory用户种类
工厂类相关FactoryConnectionFactory连接工厂
启用相关EnabledExportEnabled开启导出
流相关StreamUploadStream上传流
读取器相关ReaderExcelReaderExcel读取器
写入器相关WriterExcelWriterExcel写入器
适配器相关AdapterIntroOPAdapterIntroOP适配器
提供器相关ProviderMemebershipProvider会员信息提供器
包装器相关WrapperProductWrapperProduct包装器
连接相关ConnectionExcelConnectionExcel连接

1.20 常见类型命名

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

类型命名类型命名
客户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.21 常见字段、属性命名

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

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

2. XHTML 代码风格要求

2.1 如果XHTML标记有层次,那么代码也要有层次

下面是书写符合要求的例子:

下面是书写 不符合要求 的例子:

2.2 所有标记必须闭合

示例代码如下:

2.3 如果标记中间代码超过20行,则应在标记末尾加注标识

标注方式如下:

3. CSS 代码风格要求

3.1 代码使用半展开

设置方法参考1.4节。

3.2 使用Tab作为缩进,并设置缩进大小为4

设置方法参考1.5节。

3.3 代码注释

注释主要说明该样式应用于页面的哪个部分,而非说明样式的应用效果,代码注释风格如下所示:

3.4 代码编写

每一个样式设置必须独占一行,不能位于同一行,下面是符合要求的写法:

下面是 不符合要求 的写法:

3.5 嵌入式样式的比例不超过样式表代码总量的10%

嵌入式样式为直接写在HTML标记内部的样式,如下图所示:

3.6 内联式样式的比例不超过样式表代码总量的30%

内联式样式为写在<head></head>中的样式,如下图所示:

内联式样式,不能 写在<body></body>之间。

3.7 外联式样式表的比例不少于样式表代码总量的60%

外联式样式表为写在.css文件中的样式,通过link引入到XHTML页面中,如下图所示:

4. JavaScript 代码风格要求

4.1 代码使用半展开

设置方法参考1.4节。

4.2 使用Tab作为缩进,并设置缩进大小为4

设置方法参考1.5节。

4.3 代码注释

代码注释需要说明“函数功能”、“入口参数”、“返回值”,注释范例如下:

其中第一行说明函数功能;第二行说明入口参数;最后一行说明返回值

4.4 不得出现内嵌式代码

内嵌式代码是指写在XHTML标记中的JavaScript代码,下面的写法是 不符合要求 的:

4.5 内联式代码占JavaScript的总量不得超过40%

内联式代码是指写在<head />或者<body />之间的代码:

4.6 外联式代码占JavaScript的总量至少为60%

外联式代码指写在单独的.js文件中,然后通过script标记连接到XHTML页面中的代码。


二十四小时专线:13377997520 15327515186 13310503958
Copyright 2007-2015 0724Cx.Com All Right Reserved  鄂ICP备15019628号