开发人员手册VSNET开发规范篇VIP专享VIP免费

第1页共24页编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第1页共24页密级：秘密开发人员手册开发规范篇文档最后修订者及日期：孙立新2009-3-16本版文件批准人及日期：浪潮集团山东通用软件有限公司第2页共24页第1页共24页编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第2页共24页目录第3页共24页第2页共24页编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第3页共24页第4页共24页第3页共24页编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第4页共24页1导言1.1目的本文档是为基于®公司的®-系列开发工具进行软件开发的一个规范性文件。其目的是：保证软件开发过程中有一个统一的标准可以进行参照：包括类库、公共接口、设计模式、命名规范等。能够合理的使用公用资源1.2适用范围本文档主要是基于目前三层架构开发模式中的方式进行描述的，并同样适合于传统的三层架构：。1.3术语定义可访问性修饰符：（公有）、（内部公有）、（受保护）、（受保护或内部公有）、（私有）。在此约定好中英文对照名称。非私有包括：公有、内部公有、受保护、受保护或内部公有。1.4参考资料1.《1.2》2.《2.0》1.5版本更新记录版本/修订版修改确认日期修改内容概述起草人审核人备注1.02003-10初始版本鞠强曲丽君2.02008-03代码风格章节调整命名规范细化样式调整孙立新2使用的开发工具：®2005®-第5页共24页第4页共24页;;;;;;;31使用的命名空间代码示例编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第5页共24页3程序源代码风格定义源代码风格规范是在编写源代码文件时，对于书写格式和规则的统一要求。编写源代码最基本的目标是能够经过编译生成可执行程序。此外，源代码的另一个主要目标是为了阅读，源代码不仅仅是为了编译器能够读懂，同时也是为了人能够读懂，且易于读懂。这就如写文章的句读、段落、章节等类似，如果没有一种良好的书写风格和习惯，不仅仅会使写出的文章难以阅读，而且可能会造成不少曲解。有句话叫“文如其人”，代码也同样是“文如其人”。此外，作为一个协作密切的开发团队，非常有必要保持一致的代码书写风格，它有助于团队开发保持高效（沟通交流、代码阅读、工作交接、工作延续性等方面）。3.1代码结构风格对于每一个代码文件（*），它的内容分为如下两个部分：使用的命名空间类型定义使用的命名空间，要求必须都声明在代码文件的最前方。建议中定义的命名空间放在最上面，然后根据与当前代码关系的远近依次排列，对于引用的命名空间，按照引用来源分段列示，段与段之间用空行分隔。示例图如下：在类型定义部分，一个代码文件原则上只包含一个如下类型的定义：类、接口、结构、枚举。这样有利于构造出条理清晰的代码文件结构，一目了然。对于委托的定义，可考虑在一个代码文件中集中定义内聚度较高的一类枚举。对于类的定义，按照一下顺序定义：常量字段第6页共24页第5页共24页编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第6页共24页构造函数析构函数属性方法事件所有的类成员必须显式的声明访问修饰限定符（、、、）。为使类型具有良好的封装性，其中字段类型只能声明为。对于接口和结构体定义，其成员声明顺序与类定义相同。每行代码只允许写一条语句。每行代码写多条语句往往会造成调试定位、注释以及阅读的困难。3.2注释风格传统的注释风格：单行注释符号“”和多行注释符号“/**/”在中依然可以使用。在中，提供了额外的文档注释标记（）。3.2.1单行注释单行注释，即形式为“”的注释。单行注释用于方法内的代码注释。如对局部变量声明的注释或代码行、代码段的注释。单行注释可单独一行，如果仅仅针对一句注释，且不影响换行，可放于代码行后部。单行注释也可以用于临时屏蔽不用的代码行，在开发完毕后应及时清理。特殊的，单行注释用于代码文件声明的注释，见。3.2.2多行注释多行注释，即形式为“/**/”的注释。一般的，不建议在代码中使用多行注释。多行注释可用于临时屏蔽不用的代码行，在开发完毕后应及时清理。3.2.3文档型注释...