《PV二手车信息系统开发实施(二期)编码规范》由会员分享，可在线阅读，更多相关《PV二手车信息系统开发实施(二期)编码规范（30页珍藏版）》请在金锄头文库上搜索。
1、PV二手车信息系统开发实施（二期）编码规范版本序号1.0深圳联友科技有限公司文档修订版本编辑日期编辑人批准日批准人描述（注明的条款或页）前 言本规范适用于DOTNET平台下的C程序语言编辑。其目的在于项目编码过程中规范C软件编程风格，形成一套具有特色的编成风格，从而提高软件源代码的可读性、安全性、后期维护和重复使用。便于解决在程序开发阶段中，开发人员或项目组出现调整以至重大变动中的工作转接和交接问题，减少对项目开发阶段时间的延误，方便对已编写的代码的理解，以及程序代码的后期维护和改进升级。最终提高软件源程序的开发质量和可维护性，减少项目在后期软件维护和升级的成本。规范内容包括：代码布局、注释、
2、命名规则、声名、表达式与语句、类与接口等。规范分成规则性和建议性两种：对于规则性规范，要求所有开发人员严格执行；对于建议性规范，要求项目程序开发人员根据实际情况选择执行。项目组必须严格按照此编码规范进行，所有的程序编写和修改的代码执行本规范，项目经理和开发组长必须加以监督执行。1. 全体构成1.1 源文件的记述方法C#源文件（AssemblyInfo.cs除外）的记述方法如下图所示。 参照（）内数字的表示顺序(1) namespace(2) using （import）(3) 型定义(4) class、结构体、interface、 enum 的定义(4)-1 field(4)-2 static
3、 constructor(4)-3 instance constructor(4)-4 destructor(4)-5 propertyproperty、 index(4)-6 public method(4)-7 protected method(4)-8 protected internal method(4)-9 internal method(4)-10 private method(4)-11 event handler(4)-12 event(4)-13 内部定义型(3) 嵌套型定义(5) delegate 定义1.2 REGION的使用Construct、Property、Met
4、hod、内部型的定义按照后面的记述顺序进行总结记述，在每个总结的前后使用#region#endregion 指示记述。处理group的名称如果记述了protected method的话，记述为protected method。 在#endregion的前面不能加入空白行。以下是处理group的名称的一览。（C#中使用 #Region #End Region）accessibility处理group名称记述字段#region 字段#endregion静态的构造器#region 静态的构造器#endregion构造器#region 构造器#endregion属性#region 属性#endregi
5、onpublicpublic（method）#region public（method）#endregionprotectedprotected（method）#region protected（method）#endregionprotected internalprotected internal（method）#region protected internal（method）#endregioninternalinternal（method）#region internal（method）#endregionprivateprivate（method）#region private（m
6、ethod）#endregionEvent Handler#region（Event Handler）#endregion事件（Event）#region 事件（Event）#endregion内部型定意（内部型定义）#region 内部型定義（内部型定义）#endregion代表（Delegate）#region 代表（Delegate）#endregion2. 命名规范优良一致的命名规则能极大地增加可读性和可维护性。同时，对于一个有上百个人共同完成的大项目来说，统一命名约定也是一项必不可少的内容。本章对程序中的所有标识符（包括命名空间、变量名、常量名、控件名、参数名、属性名、方法名、类名、
7、接口等）的命名做出约定。2.1 首字母风格Pascal和Camel命名约定编程的命名方式主要有Pascal和Camel两种（Pascal：每个单词的首字母大写，例如ProductType。Camel：首个单词的首字母小写，其余单词的首字母大写，例如productType）。标志符规则实例与描述类classPascalApplication枚举类型enumPascal记住，是以Pascal命名，切勿包含Enum，否则FXCop会抛出Issue委托delegatePascal以Pascal命名，不以任何特殊字符串区别于类名、函数名常量constPascal仍然提倡使用Pascal命名，以能通过FX
8、Cop检测接口interfacePascalIDisposable 注：总是以 I 前缀开始，后接Pascal命名方法functionPascalToString命名空间namespacePascal以.分隔，当每一个限定词均为Pascal命名方式，比如：using ExcelQuicker.Framework参数Camel首字母小写局部变量Camel也可以加入类型标识符，比如对于System.String类型，声明变量是以str开头，string strSQL = string.Empty;数据成员以m开头Pascal命名规则，如mProductType（m意味member）属性Pascal
9、2.2 单词选择避免使用.NET Framework namespaces 中的关键字作为类名,比如：不要用以下的任何一个作为类名：System, Collections, Forms, 或者 UI。并且，不要使用和以下关键字重复的命名AddHandlerAddressOfAliasAndAnsiAsAssemblyAutoBaseBooleanByRefByteByValCallCaseCatchCBoolCByteCCharCDateCDecCDblCharCIntClassCLngCObjConstCShortCSngCStrCTypeDateDecimalDeclareDefaultD
10、elegateDimDoDoubleEachElseElseIfEndEnumEraseErrorEventExitExternalSourceFalseFinalizeFinallyFloatForFriendFunctionGetGetTypeGotoHandlesIfImplementsImportsInInheritsIntegerInterfaceIsLetLibLikeLongLoopMeModModuleMustInheritMustOverrideMyBaseMyClassNamespaceNewNextNotNothingNotInheritableNotOverridabl
11、eObjectOnOptionOptionalOrOverloadsOverridableOverridesParamArrayPreservePrivatePropertyProtectedPublicRaiseEventReadOnlyReDimRegionREMRemoveHandlerResumeReturnSelectSetShadowsSharedShortSingleStaticStepStopStringStructureSubSyncLockThenThrowToTrueTryTypeOfUnicodeUntilvolatileWhenWhileWithWithEventsW
12、riteOnlyXorevalextendsinstanceofpackagevar2.3 命名空间命名命名空间命名的主要规则是 用 LY + TechnologyName + feature + designCompanyName.TechnologyName.Feature.Design例如:Microsoft.MediaMicrosoft.Media.Design2.4 类命名A 使用名词或者名词词组。B 用Pascal约定C 尽量不使用缩写E 不使用下划线(_)。以下是正确的命名C#public class FileStreampublic class Buttonpublic cla
13、ss String2.5 接口命名A 使用名词或者名词词组。B 用Pascal约定C 尽量不使用缩写D 以字母I作为前缀E 不使用下划线(_)。例如：C#public interface IServiceProviderpublic interface IFormatable2.6 属性命名A 使用名词或者名词词组。B 用Pascal约定C 与它指代的含义相似。如果你想声明一个属性color，那么这个属性的名字要与color很相似。比如：public class SampleClass public Color BackColor / Code for Get and Set accessors goes here. 以下的这种方式就是错误的 C#public enum Color / Insert code for Enum here.public class Control public int Color get / Insert code here. set / Insert code here.
