山西光远科技有限公司《软件开发人员手册》.pdfVIP

尸,在 •GUANGWUAN 山西光远科技有限公司 《 》 软件开发人员手册 目录 1 开发方针和开发模式3 2 编程标准 3 2.1 关于标准 3 2.2 必须添加注释让程序清晰 4 2.3 例程结构5 2.4 变量使用标准7 2.5 语法标准 7 2.6 出错处理 8 2.7 组件化的编程思想 9 3 命名约定 10 3.1 关于名称 10 3.2 对象命名 10 3.3 单命名 12 3.4 模块命名 13 3.5 例程命名 13 3.6 变量命名 13 3.7 常量常名 15 4 用户界面设计原则 15 4.1 什么是一个 “好的”用户界面设计？ 15 4.2 如何设计用户界面？ 16 4.3 用户界面设计基本原则 17 4.4 《windows界面应用程序设计指南》 22 5 文档编写指南 23 5.1 引言23 5.2 文件的编制指导 25 5.3 各种文件的内容要求 34 6 附录45 6.1 软件问题报告单(SPR) 45 6.2 软件修改报告单(SCR) 46 2 开发人员手册 1开发方针和开发模式 以用户的需求为导向，以严格科学的组织管理为前提，以先进的技术为保 障，注重质量，注重效率。 2编程标准 2.1 关于标准 编程标准是在实际书写项目代码的准则。它们确定诸如程序结构、变量作 用域，语法标准，出错处理和加入注释等事项。在开始编写代码之前，确定编 码标准就能使编码在开发小组成员之间更加标准化，从而简化开发与维护工 作。 编程标准能够：（1）帮助你管理软件的复杂性，并且使你的代码组织得 更易于找到你所查找的部分。（2）它提供易于阅读和理解的代码一致的外观, 任何熟悉所用标准的程序员将能够找出任何一段代码，并理解所用的基本约 定。在你作代码的初检时，在你的测试小组作代码检查时，以及多个程序员完 成一个项目时，这都是有帮助的。（3）它保证平稳地转换到软件的维护阶段, 特别是当维护工作是由另外一些人完成时。 我们提出标准的原则是可以遵循的，并有很强的可操作性，建立标准不是 我们的目的，目的是让大家有一种可以相互埋解的“共同语言”。 编程标准包括：加注解、基本的代码结构、变量用法、语法标准、出错处 理等。 3 2.2 必须添加注释让程序清晰 注释必须在编码的同时加入，它将有助于记住程序的目的。代码变动时， 注释也应随之改动，必须保持注释是最新的。 2.2.1 模块注释 所有模块（窗体，标准模块和类）都应当以一个说明目的和对它所做过的 任何修改的简要注释开始。 例如 类名：CScoye 作者：王大海，开发中心 日期：1996/12/1 描述：记录联机考试的成绩 修改： 2.2.2 例程注解 所有例程（子程序，函数和属性过程）都应当以说明其功能特点（做什么） 的简要注释开始。这一注解还应当包括传给本例程和由本例程返回的参数。 这种描述不应当描述实现细节（怎样做？），因为这些细节常常随时间而 变化，因而导致不必要的注解维护工作。或者更坏，导致错误的注释。代码本 身和任何必要的局部注释将描述这种实现过程。 例如： ’准备一个提示信息 参数： temp 用户名 i 反映状态 返回值： string 提示信息 Function myFunc (temp As String, i As String) As