代码规范2CodingRule2.doc

开发规范: C# 作者AUTHOR : IT 文档编号DOC. ID : 200710001 级别REV. LEVEL : 1 日期DATE : 2007-10-24 状态STATUS : Release 摘要Abstract 本规范意在对于以下事项产生积极的影响(The objective of this coding standard is to have a positive effect on) 避免BUG，特别是一些难以发觉的。(Avoidance of errors/bugs, especially the hard-to-find ones.） 可维护性，通过提倡使用一些设计原理。(Maintainability, by promoting some proven design principles.) 可维护性，通过要求或建议应用统一的风格。(Maintainability, by requiring or recommending a certain unity of style.) 性能要求，通过劝阻一些不良的习惯。(Performance, by dissuading wasteful practices.) 规范和建议意在提高软件系统的可靠性与可维护性。(Rules and recommendations are given that promote reliability and maintainability.) 目录catalog 1 一般规则General rules 3 1.1 概述Overview 3 1.2 规则与建议Rules and Recommendations 3 2 命名规则Naming conventions 4 2.1 概述Overview 4 2.2 规则与建议Rules and Recommendations 5 3 注释和内嵌文档Comments and embedded documentation 12 3.1 概述Overview 12 3.2 规则与建议Rules and Recommendations 12 4 编码风格Coding style 15 4.1 概述Overview 15 4.2 规则与建议Rules and Recommendations 15 一般规则General rules 概述Overview Rule 2@102: 如果有违背建议规则的情况发生，必须有很好的理由。Every time a recommendation is not followed, this must have a good reason. Rule 2@105: 不要在一个文件中搀杂不同提供者的编码。Do not mix code from different providers in one file 规则与建议Rules and Recommendations Rule 2@102: 如果有违背建议规则的情况发生，必须有很好的理由。Every time a recommendation is not followed, this must have a good reason. 好的理由并不包含个人习惯的风格。Good reasons do not include personal preferences of style. Rule 2@105: 不要在一个文件中搀杂不同提供者的编码。Do not mix code from different providers in one file 一般而言，第三方代码都不会遵循我们的编码规范，所以，请不要将这样的代码放入我们的文件。In general, third party code will not comply with the coding standard, so do not put such code in the same file as proprietary code.  命名规则Naming conventions 概述Overview Rec. 3@101: 应英文来命名标识符。Use US-English for naming identifiers. Rule 3@102: 用一般案例说明命名标识符。Use general casing for naming identifiers. Rule 3@103: 不要使用如匈牙利语等不利于阅读或者用其他标识符来做标识符。Do not use Hungarian notation or add any other type ide