项目代码风格要求(转自博客园-张子阳)
博文原址:http://www.cnblogs.com/JimmyZhang/archive/2013/06/05/3118936.html#2815176
代码风格没有正确与否,重要的是整齐划一,这是我拟的一份《项目代码风格要求》,供大家参考。
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 | List<Product> productList |
DataTable/HashTable | Table | HashTable productTable |
字典 | Dictionary | Dictionay<string,string> productDictionary |
EF中的DbSet /DataSet | Set | DbSet<Product> productSet |
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%
内联式样式为写在<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页面中的代码。
项目代码风格要求(转自博客园-张子阳)相关推荐
- 【转载】windows 如何一键关闭所有进程程序 --- (博客园 - 木人子韦)
[转载]Windows 如何一键关闭所有进程程序 --- (博客园 - 木人子韦) 1.桌面创建一个快捷方式,点击鼠标右键跳出的菜单=> 新建=>快捷方式 01 在"请键入对象的 ...
- debug idea js_IntelliJ IDEA 配置chrome插件调试js代码 - 狂奔的熊二 - 博客园
调试js代码,每次都在要在代码中写debugger,或者在chrome中打断点,而且chrome的断点信息不人性化.偶然发现idea竟然有这个功能,简直神器啊.研究了半天终于搞定了,哈哈,开心.下面是 ...
- mybatis自动建表oracle,利用mybatis-generator自动生成代码 - 菩提树下的杨过 - 博客园...
mybatis-generator 有三种用法:命令行.eclipse插件.maven插件.个人觉得maven插件最方便,可以在eclipse/intellij idea等ide上可以通用. 下面是从 ...
- 将微博或者qq空间的说说同步至博客园 wcf+js(ajax)跨域请求(1)
前天刚写了篇文章使用Bootstrap为你的博客园自定义轮播图片(今天将图片加载的顺序调整了下,不在访问的时候直接加载,而是页面加载最后在脚本里面动态添加dom元素),虽说技术含量不怎么高,但是大家还 ...
- 详谈如何定制自己的博客园皮肤
前言 最近,有很多博客园的朋友给我留言或私信,询问我的博客背景是如何做的. 不是我敝帚自珍,而是由于内容较多,一一回复实在是太费劲.没有及时答复的朋友,请见谅. 我在这里做一次集中式分享,如果有喜欢的 ...
- 详谈如何定制自己的博客园皮肤【转】
转自:http://www.cnblogs.com/jingmoxukong/p/7826982.html 目录 前言 Quickstart 定制博客园 CSS 的原理 页面定制CSS代码 博客侧边栏 ...
- css文件插入背景音乐,博客园添加背景音乐,背景效果!
博客园添加背景音乐,背景效果 申请博客园js权限 申请话术 实例 尊敬的博客园管理员: 请求申请开通js权限,希望能够把自己的博客修饰的漂亮点,点缀自定义js插件效果,希望管理员可以批准,谢谢! 开通 ...
- 定制和我一样的博客园主题
有园友问我的博客园的主题怎么弄的,我答应了要发一篇博文分享一下我的博客主题配置.其实是很简单的,相信懂 CSS 的人都能自己搞,但如果你懒得花时间,正好可以直接复制我写好的配置代码. PS:按照博客园 ...
- markdown mysql高亮_修改博客园markdown编辑器代码高亮风格的方法
作为一个工程师,追求极致与艺术也应当成为我们生活中的一部分,作为自己的心爱之物--博客,当然也得装扮一下,我对代码高亮有自己所喜欢的风格~还好程序员的世界总是共通的,已经有前辈开发了一些代码高亮的样式 ...
最新文章
- java多线程(3)Thread的静态方法
- FD.io/VPP — ACL
- C#线程从陌生到熟悉(4)
- 菜鸟程序员的成长之路-工作篇
- Nginx 301与302配置
- Java开发技巧:Java如何编译运行?
- stm32驱动ssd1306配置_STM32 OLED 屏幕 驱动芯片SSD1306 IIC代码
- [html] 在a标签中,怎样防止链接跳转?
- 系统软键盘Android在外接物理键盘时,如何强制调用系统软键盘?
- 如何下载vSphere Big Data Extensions 1.0免费试用版
- Linux云用户,Linux 用户与权限
- sqlplus连mysql库_sqlplus连接数据库
- Navicat for MySQL 12.0.26 中文破解版 数据库管理工具
- 大觉寺-阳台山穿越记
- 网络安全等级保护2.0详解
- 分享应用于桌面闹钟的超低成本MG127蓝牙射频前端芯片
- 数据库及SQL语句入门教程
- 前端开发框架:Ajax的基本入门和使用。
- 《勋伯格和声学》读书笔记(十):减七和弦
- 黑苹果安装教程OC引导
热门文章
- 数据结构与算法lab1-哈工大
- 幸福我值得拥有————
- boot spring 叶子暗的_抓住MySQL面试重点知识,让你征服面试官半小时
- 基本注解详解@RequestMapping,@GetMapping
- html登录状态验证,Token验证登录状态的简单实现
- 为什么变频空调省电的原理和分析
- python网络安全论文题目_计算机科学与技术专业毕业论文参考题目.doc
- 大学四年里 你要走遍全国吗?!(自助游信息整理大集合)
- 绘画遇到瓶颈期怎么办?拒绝正面刚跨过瓶颈期
- AGRCZO-A-10/315先导比例减压阀放大器