计算机编码程序设计说明书

1 计算机编码程序设计说明书 第 1 章 序言 所谓编码就是基于在程序设计时作成的程序设计书和流程图等逻辑设计、用编程语言、对为在计算机上实现某些功能的逻辑进行描述的工作。 在编码过程中、为了消除因程序员水平不同而造成的差异、为了顺利的进入单体测试阶段、同时也为了维护方便、以下整理了编码的准备和代码书写的标准。 而且、关于书写标准、除非客户有指定的要求、或者使用了（半）自动生成代码的工具话、则应尽量遵从这个标准。 本规范是以使用 开发 应用程序为前提的。 第 2 章 编码的准备 （ 1） 以系统设计书、程序设计书（根据情况也包含流程图等的逻辑设计书）为基础。 （ 2） 在完全理解了以上文档内容的基础上开始编码工作（特别是程序设计书的作者和编码的担当者不同时）。对于不明白的地方不要随意判断、要进行确认。 （ 3） 始终注意要把程序的易理解性（易读性）放在第一位。为此、在编程时要时刻想着程序的读者、本着以向读者说明的态度来编写程序是写好程序的关键。读起来容易理解的程序一般来说总是质量优良、而且容易改造的。 （ 4） 象数据库的记录的规范等 件、模块头、宏定义等系统应该统一的东 西、要采用系统规定的东西、不要根据个人的意愿随意的作成、否则、这将成为在进行变更和改造时发生问题的原因。 （ 5） 编码结束后、要对代码进行检查。不检查代码则不能轻易的进入下一步的测试阶段的工作。检查代码不仅是最容易发现错误的方法、而且有时还能检出在测试时不易发现的复杂错误。 第 3 章 命名规约 2 3 1 . 使用的目的 命名规约以以下 4 点为目的的而使用。 （ 1） 容易明白会使应用程序的结构代码等容易理解。 （ 2） 确立开发小组“通用语言”、使全体成员用同样的“语言”来开发应用程序。 （ 3） 使 易被使用。 （ 4） 用较少的劳力作成 发用的工具、在各式各样的 台里通用的源码库。 本规约是用遵从被 为标准的 名规则（ 以下称 方法来规定命名法的。 3 2 . 结构化 以下格式对 行命名。 缀 签 本名 词 缀 对各个部分按顺序进行说明。 . 前缀（ 前缀是在标签前面的识别符、是对标签进行进一步详细说明的。前缀用 1 到 2 个小写字母组成。对 1 个 数个前缀可以组合使用。 前缀有表示有效范围的和表示变量特性的。另外、 2 个前缀能够重叠使用。 （ 1） 表示有效范围的前缀 表 1 . 表示有效范围的前缀 无 的局部变量 s 用 明的 局部变量 m 在模块 用 明的模块水平的变量 3 p 在模块的 明的变量 g 在模块的 为 明的变量 （ 2） 表示变量特性的前缀 表 2. 表示变量特性的前缀 a 作为数组声明的变量 c 用 明的变量 e 作为的 要素的变量 i 作为数组的 循环的计数器使用的变量 r 传递给 数的作 为参照传递 ( )声明的变量 t 作为用户定义型定义的变量 v 传递给 数的作为值传递 ( )声明的变量 （ 3） 例 值传递的参数： 照传递的参数： 明的数组的 量： 明的变量： 4 . 标签（ 标签是表示基本名的特征的复数个的字母、放在基本名的前面。标签基本上相当于面向程的类识别符。标签用 3 到 4 个小写字母组成。 标签是表示基本名的特征的复数个的字母、表示变量的型啦的种类。从标签表示的意思上可以对数据型、模块、 件的标签进行分类。 （ 1） 数据型 表 3. 数据型标签 布尔值 长整数 精度浮点数 符串 误 户定义 数 2） 模块、 件 表 4 模块标签 表 5. 标签 类模块 对 话框 准模块 单 4 表 6. 控件标签 件 ox 单 性 单项 ab ox ox 3） 例 判定成功用的变量： 文件名： 检索处理用的标准模块： 主 5 . 基本名（ 基本名是设 是最先遇到的部分、是不管采用不采用命名规则都必须使用的名字。基本名要用有意义的单词（原则上用英文单词）来组合、各个单词的第一个字母大写其余用 小写。这时、再加上专用名词的情况下、要用日语的罗马字。但是、用 明的变量的基本名全部用大写。另外、虽然没有限制、基本名还是要选择不太长的名字。 作为基本名的样本用在 码里的标准的作业变量表示如下。 表 7 . 标准 业变量 受函数调用的返回值（ 持 值 环计数器 受 数的返回值 持算术演算的接果（ 同样 ） 受函数调用的返回值（ 同样） 在所有暂时的作业（ 同样） 成 符串 3 6 . 量词（ 量词表示 关联上是怎样被利用的。（最大、最小等）量词要尽量短、用大写 5 表 8 . 量词 贮 1的现在的要素 贮 1的最初的要素 贮以后要使用的 要素 贮 1的最后的要素 贮 1的最大要素 贮 1的最小要素 贮 1的下一个的要素 贮的新的 值 贮的以前的 值 贮 1的前面的要素 贮 贮暂时的值 3 7 . 后缀（ 后缀是以在按照命名规则时变成的名字的 上识别符为目的而添加的。所以不是非要不可、根据 定是否采 用。 假设 联的标准模块有 。这时、如果存贮错误码的变量设为、在各个模块里确保变量的话、就会区别不开。如果在取各个模块的大写的 2 个字母作后缀、各个变量就能区别开。 - - - - 然后缀的决定方法没有特别的基准、还是要选择容易明白区别基准的 2 到 3 个字母的字符串。另外、大写字母、小写字母可以任意使用。 第章 模块头 模块头对了解模块的概要是很有效的、另外还有助于维护。所以、对此必须记述。 4 1 . 外部模块头 外部模块头要记述以下项目。（有关程序全体的信息在 件（文件名 =程序 6 名 述。） （ a ）模块识别信息 系统名 客户名 程序名或模块名 担当部科名 著作权表示 （ b ） 模块说明 功能 参数说明 动作环境 /作成环境 作成担当着名 （ c ） 履历 作成日时（单体试验完成日） 变更日时 变更内容 版本信息 （ d ）补充说明 外部模块头 * o. 系统名 ：系统名 客户 ：客户 程序 ：程序名称 担当部长 ：沈阳东东系统集成有限公司 开发一部 * 功能 ：功能概要 参数 ：对有关重要参数进行说明 作成环境 ：工具、编译环境、 动作环境 ： 约条件 担当 ：担当者名 作成日 ： 1999 年 5 月 28 日 （ * 7 变更履历 1999 年 5 月 28 日 所属 担当者名 变更理由 变更内容 1999 年 6 月 15 日 所属 担当者名 变更理由 变更内容 */ 8 4 2 . 内部模块头 在内部模块头写下以下项目。 （ a ）模块说明 功能 参数说明 动作环境 /作成环境 作成担当者名 （ b ）履历 作成日时（单体试验完成日） 变更日时 变更内容 版本信息 （ c ）补充说明 内部模块头 * 功能 ：功能概要 参数 ：对有关参数进行说明 担当 ：担当者名 作成日 ： 1999 年 5 月 28 日（ 0） * 变更履历 0 1999 年 5 月 31 日 所属 担当者名 变更理由 . 变更内容 0 1999 年 6 月 15 日 所属 担当者名 变更理由 . 变更内容 * 9 4 3 . 注释语句 1. 考虑到提高维护性、以模块及块为单位写上内容说明、以便马上能找到修改的地方。 2. 为了帮助读者理解程序、在不容易理解的逻辑上加上说明。不是在只读了程序马上就能理解的地方加上注释、而是要象给读者提供新信息之类的说明。例如、写上在那里使用的算法的注释。 3. 不要加上不必要的注释。在注释之前、先要在识别符命名法、整理 程序构造上下工夫使程序容易被读懂。 4. 注释语句尽可能写的简单明了 . 5. 注释写在语句的前面时要和语句的列对齐。 注释 、把源码删除、改成注释时、不要用不容易弄清范围是否有效的写法。 删除 删除 . 变更 修改程序时对注释也必须进行维护。 第 5 章 错误处理 错误处理有“结构化错误处理”和“ 误处理” 2 种方法。现在的主流虽然是“结构化错误处理”、根据系统也可以使用“ 误处理”。 另外、也可以把两个组合起来使用。但是、必须对所有的错误的发生都执行错误处理来进行编码。 5 1 . 结构化错误处理 结构化错误处理是以“ 语句来记述、在 部分记述错误处理的方法。 这时、错误处理程序 则上写在 最后、 设成、“错误名”+“ 名字。 10 5 2 . 误处理是在错误发生后马上 误的编码方法。 为了实行这个、实施以下 2 点。 在 开始处写上“ 句 在有可能发生错误的码的紧后面编进确认逻辑。 第 6 章 编码规约 6 1 . 函数化 在符合以下条件的情况下、要把处理汇总成子成序。 2 个地方以上被使用的处理 超过 100 步的处理 独自作成的函数要写在 件里。 这时、 件的最大步数不要超过 500 步。 关于被 2 个以上可执行文件使用的函数、共享包含那个函数的 件。 6 2 . 常数的使用 关于字符串的尺寸、上限值、下限值等预先定下来的值、要把这个作为文字常数来定义并使用此常数。 6 3 . 变量的声明 6 3 1 . 变量声明 （ 1 ）“ 明 明使声明所有的变量在参照前必须进行声明的声明。在作成新模块时、必须进行这个声明。或在环境中设置。 11 （ 2 ） “ 明 明是为了声明变量并 分配存贮领域而使用。因为声明因生明的地方不同而使范围不同、所以如果希望范围明确的话、用“ “ 明进行声明。 用“ 明进行变量声明时、必须把变量的型用“ 来声明 这时、在进行复数个变量声明的情况下、要给各个变量加上“ 例 ） 这种情况下、 的 3 个变量被生明。 ,这种情况下、 的 s z s z 和 的 s z 变量被声明。 （ 3 ）“ 明 这些声明是在对水平的变量进行声明时使用。“ 对 通用的变量、“ 只对模块内使用的变量使用。 （ 4 ）“ 声明 在对 平的变量进 行声明时使用。用“ 明的变量在程序执行期间内成为有效的变量。 （ 5 ）“ 明 块两方多可使用。用“ 明的变量不能变更。 用“ “ “ 明的变量要预先记载在设计书上。另外、尽可能地把这些变量汇总在 1 个标准模块上声明。 6 3 2 . 变量的范围 变量由于声明的地方和声明的种类不同有效范围会有所不同、所以要在考虑范围后再对变量进行声明。 6 4 . 函数及子程序的声明 函数的声明 参数“ “ 声明必须进行。 读入在 义的函数时、要对被 函数名确认后在进行声明。用更函数名时、要用容易明白原来的函数名的名字。 6 4 1. 用子程序时、有用和不用 用的方法、在系统中要统一。 12 6 4 2 . 明函数时、要用 形式对返回值进行声明。 6 5 . 控制语句 6 5 1 . I F 关条件比较、必须考虑进 行记述。 原则上要用肯定型 条件比较。 进行变量比较时、原则上不使用神秘数用全局变量或常数进行比较。 例） if 1 if 10 1 5 2. 把循环变量写在 后面使循环的范围容易明白 例） 1 00 1 1 00 1 13 5 5 3. 于语句的各个值的意义要写上注释。 另外、考虑到取得预期以外的值的情 况要加进 句。 句嵌套时、要写上注释使对应的 易被明白。 例） 1 “ 情况 1 2 “ 情况 1 上记以外的情况 0 1 1 2 1 1 “ 情况 0 “下一页”的情况 1 1 “再下页”的情况 2 上记以外的情况 2 “ 情况