文档介绍：卷号
卷内编号
密级
重庆普耀科技有限公司
普耀科技公司,2005
C# 编码规范
Version
作者:汪卫星
文档信息
标题:C# 编码规范
作者: 严博文
创建日期:2005-4-20
上次更新日期:2007-4-25
版本:
部门名称: SEPG
修订文档历史记录
日期
版本
说明
作者
2005-4-20
创建
严博文
2005-11-21
将“4最佳实践”重新规类
汪卫星
2007-4-25
李发陵
、
目录
1. 简介 1
目的 1
范围 1
定义、首字母缩写词和缩略语 1
参考资料 1
概述 1
原则 1
便于阅读 1
与工具集成 1
VISO 1
配置工具 2
编码工具 2
便于调试 2
便于写作 2
减少重复 2
2. 程序设计标准 2
通用命名约定和风格 2
采用该领域的术语 2
大小写 2
使用可以准确说明的英文描述符 2
下划线的使用 2
避免使用长名字 3
标识符的命名 3
通用格式编码规则 4
圆括号规则 4
缩进规则 4
If Then Else规则 5
比较规则 5
Case规则 5
对齐规则 5
单语句规则 5
单一功能规则 5
简单功能规则 5
明确条件规则 5
选用FALSE规则 5
独立赋值规则 6
行宽 6
折行 6
在分号处折行 6
在操作符前折行 6
有多个可以选择的地方时,选择层次较高的进行折行 6
将新行与上一行的同一级的表达式的开始处对齐 6
方法定义的折行 6
简单地缩进一级 6
注释 7
7
C# 注释语句类型 7
按目的分的注释类型 9
业务逻辑注释 9
外部注释 9
变量注释 9
3数据 9
9
10
11
12
12
13
13
14
类和对象问题 14
变量方法问题 14
注释问题 15
逻辑结构问题 15
16
简介
本文提供一整套编写高效可靠的C#.NET代码的标准、约定和指南。它们以安全可靠的软件工程原则为基础,使代码易于理解、维护和增强。而且,通过遵循这些程序设计标准,你作为一个 C#.NET 软件开发者的生产效率会有显著提高。经验证明,若从一开始就花时间编写高质量的代码,则在软件开发阶段,对代码的修改要容易很多。最后,遵循一套通用的程序设计标准将带来更大的一致性,使软件开发团队的效率明显提高。
目的
本文档用于指导编码,并确立起一个易于理解、维护,并同软件过程及过程工具紧密集成的编码约定。
范围
本文档对适用所有采用C#.作为平台的开发语言开发的项目。
定义、首字母缩写词和缩略语
注释率注释在代码中所占比例。
语句
注释 在源文件中
C#语言风格注释
行内注释
文档注释
参考资料
C# coding standards
概述
本文档共分为六部分:
第一部分为简介;
第二部分程序设计准则;
第四部分为描述与工具的集成;
第五部分为本文档所规定的一些数据;
第六部分为建议的最佳实践。
原则
本节描述描述制作本文档时所采取的原则,这些原则是一开始就确定的,并且贯穿在整个文档中。以下的原则的排列是按优先级进行的,这也就是说,在原则之间有冲突时,应该优先考虑排在前面的项目。
便于阅读
从软件工程的角度上来看,代码让人更容易看懂远比让机器看懂更有价值得多。首先代码永远不进行维护似乎是很少发生的,其次,就算代码永远不进行维护,至少为了代码重用的目的也需要其他人能够很容易地看懂代码。这里有一条30秒原则,即其他程序员能在30秒内完全