分类目录

链接

2013年七月
« 6月   8月 »
1234567
891011121314
15161718192021
22232425262728
293031  

近期文章

热门标签

博主推荐

现在位置:    首页 > .NET > 正文
C#代码风格写法
.NET 暂无评论 阅读(1,502)

 

代码个性没有正确与否,重要的是整齐划一,这是我拟的一份《项目代码个性需求》,供我们参阅。

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 常见调集类型后缀命名

凡契合下表所列的调集类型,应增加相应的后缀。

阐明 后缀 示例
数组 Array int[] productArray
列表 List ListproductList
DataTable/HashTable Table HashTable productTable
字典 Dictionary Dictionay productDictionary
EF中的DbSet /DataSet Set DbSetproductSet

1.19 常见后缀命名

凡契合下表所列的局部变量、办法参数、字段、特点,均需增加相应的后缀。

阐明 后缀 示例 示例阐明
费用关联 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.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%

内联式款式为写在中的款式,如下图所示:

内联式款式,不能 写在之间。

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%

内联式代码是指写在或许之间的代码:

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

外联式代码指写在独自的.js文件中,然后经过script符号衔接到XHTML页面中的代码。

 

谢谢阅览,期望这篇文章能给你带来协助!

 

PDF版下载:项目代码个性需求V1.0.pdf

 

本文版权归数据库之家所有,转载引用请完整注明以下信息:
本文作者:Bruce
本文地址:C#代码风格写法 | 数据库之家