C#编码规范(欧美标准)

《C#编码规范(欧美标准)》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、.NET交流二群:131628626,.NET交流一群：84010140卷号卷内编号密级重庆普耀科技有限公司普耀科技公司,2005C#编码规范Version2.0作者：汪卫星.NET交流二群:131628626,.NET交流一群：84010140文档信息标题:C#编码规范作者:严博文创建日期:2005-4-20上次更新日期:2007-4-25版本:3.0部门名称:SEPG修订文档历史记录日期版本说明作者2005-4-201.0创建严博文2005-11-212.0将“4最佳实践”重新规类汪卫星2007-4-253.0李发陵、.NET交流二群:131628626,.

2、NET交流一群：84010140目录1.简介11.1目的11.2范围11.3定义、首字母缩写词和缩略语11.4参考资料11.5概述11.6原则11.6.1便于阅读11.6.2与工具集成11.6.2.1VISO11.6.2.2配置工具21.6.2.3编码工具21.6.3便于调试21.6.4便于写作21.6.5减少重复22.程序设计标准22.1通用命名约定和风格22.1.1采用该领域的术语22.1.2大小写22.1.3使用可以准确说明的英文描述符22.1.4下划线的使用22.1.5避免使用长名字32.1.6标识符的命名32.2通用格式编码规则42.2.1圆括号规则4

3、2.2.2缩进规则42.2.3IfThenElse规则52.2.4比较规则52.2.5Case规则52.2.6对齐规则52.2.7单语句规则52.2.8单一功能规则5.NET交流二群:131628626,.NET交流一群：840101402.2.9简单功能规则52.2.10明确条件规则52.2.11选用FALSE规则52.2.12独立赋值规则62.2.13行宽62.2.14折行62.2.14.1在分号处折行62.2.14.2在操作符前折行62.2.14.3有多个可以选择的地方时，选择层次较高的进行折行62.2.14.4将新行与上一行的同一级的表达式的开始处对齐6

4、2.2.14.5方法定义的折行62.2.14.6简单地缩进一级62.3注释72.3.1概述72.3.1C#注释语句类型72.3.2按目的分的注释类型92.3.2.1业务逻辑注释92.3.2.2外部注释92.3.2.3变量注释93数据93.1程序字符数据93.2数据类型缩写表103.3Form控件缩写表113.4COMPONENT控件缩写表123.5DATA控件缩写表123.6WEB控件缩写表133.7html控件缩写表134.最佳实践144.1类和对象问题144.2变量方法问题144.3注释问题154.4逻辑结构问题154.5代码问题16C＃编程规范v2.01.

5、简介本文提供一整套编写高效可靠的C#.NET代码的标准、约定和指南。它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强。而且，通过遵循这些程序设计标准，你作为一个C#.NET软件开发者的生产效率会有显著提高。经验证明，若从一开始就花时间编写高质量的代码，则在软件开发阶段，对代码的修改要容易很多。最后，遵循一套通用的程序设计标准将带来更大的一致性，使软件开发团队的效率明显提高。1.1目的本文档用于指导编码，并确立起一个易于理解、维护，并同软件过程及过程工具紧密集成的编码约定。1.2范围本文档对适用所有采用C#.NET和.NET作为平台的开发语言开发的项

6、目。1.3定义、首字母缩写词和缩略语注释率注释在代码中所占比例。语句注释在源文件中C#语言风格注释行内注释文档注释1.4参考资料C#codingstandards1.5概述本文档共分为六部分：第一部分为简介；第二部分程序设计准则；第四部分为描述与工具的集成；第五部分为本文档所规定的一些数据；第六部分为建议的最佳实践。1.6原则本节描述描述制作本文档时所采取的原则，这些原则是一开始就确定的，并且贯穿在整个文档中。以下的原则的排列是按优先级第23页共27页C＃编程规范v2.0进行的，这也就是说，在原则之间有冲突时，应该优先考虑排在前面的项目。1.1.1便于阅读从软件

7、工程的角度上来看，代码让人更容易看懂远比让机器看懂更有价值得多。首先代码永远不进行维护似乎是很少发生的，其次，就算代码永远不进行维护，至少为了代码重用的目的也需要其他人能够很容易地看懂代码。这里有一条30秒原则，即其他程序员能在30秒内完全读懂你的方法，理解做什么，为什么及怎样做的。1.1.2与工具集成鉴于开发过程大量地集成了工具，因此要与整个开发过程结合就必须考虑怎样使代码与工具和平相处并配合密切。与工具集成同时可以增加生产力，并减少由于人工转换过程中引入的错误。1.1.2.1VISO考虑到整个开发过程使用了RUP，因此与其所提供的工具VISO的集成是很有价值

8、的。与VISO的集成是指