威赛儿商务通系统开发员手册(UMLchina.com,转载)
日期：2009-06-26 浏览次数：20758 次
威赛儿商务通系统开发员手册
苏康胜(cancan28@163.net)
一、 前言
为了保证商务通系统项目开发成本优化并且有利于将来的扩展及重用，项目成员必须严格遵守以下开发手册。力求达成一种默认的开发规范。
二、 设计约定
l 系统将采用RDS技术访问远程组件，必须记住RDS不支持对象的属性的这一限制。
l 系统必须提供统一灵活的错误处理机制，统一管理组件的返回信息。
l 系统组件尽量遵守松耦合的原则，使组件在能重用的基础之上还能适应今后更多方面的变更。
l 为了使系统具有很强的移植性，设计要排除对使用存储过程实现的依赖等。
l 组件的设计应该避免产生过多的创建数据库连接请求。
l 详细设计必须详细到每个组件及方法和接口。
l 采用Rational Rose做为系统分析设计的辅助工具。
l 设计必须配合项目管理，辅助需求管理人员提供需求基线依据。
l 必须及时获取程序员反馈信息，修补设计时的漏洞。
l 其他补充可以找苏康胜商量。
三、 程序规范
a)VB的编程规范
在软件开发过程中，编程的工作量是相当大的，同一项目参与编程的人可能有各自编程的经验和习惯，不同风格的程序代码带来了维护工作量的增加，因此为了提高代码的可读性、系统的稳定性及维护和升级的成本，程序的代码必须严格遵循统一的编程规范。
总则：
应有良好的、尽可能一致的编程风格
编码应该是严谨的、可读性强、目标明确及直观的。
注释：
无论是用户端表示层程序还是组件程序，注释必不可少。要求能占程序总量的20%，另外注释必须在程序改变时实时更新。
每个构件的顶部应该有注释
包括：模块名称
功能描述
设计 作者
构件内的每个过程或方法应该有注释
包括：功能描述
参数说明
返回值说明
作者 更新
创建日期 最后更新日期
每个模块级变量必须给出注释
重要的变量应该给出注释
描述变量的用途
变量、常量、对象的命名规约
命名必须使用大小写结合（VB编辑器会自动转换以减少程序出错的机率）
变量命名采用[范围前缀][数组前缀][类型前缀]+[自定义命名]
控件命名采用[控件前缀]+[自定义命名]
变量范围做前缀
范围 | 前缀 | 例子 |
全局变量 | g | gStrUserName |
模块级 | m | mStrUserName |
过程级 | 无 | StrUserName |
数组前缀： a
类型前缀：
数据类型 | 前缀 | 例子 |
Boolean | Bln | BlnFound |
Byte | Byt | BytRasterDate |
|
免责声明： 本文仅代表作者个人观点，与爱易网无关。其原创性以及文中陈述文字和内容未经本站证实，对本文以及其中全部或者部分内容、文字的真实性、完整性、及时性本站不作任何保证或承诺，请读者仅作参考，并请自行核实相关内容。
|
