程序设计风格,程序不只是给机器执行的,也是供人阅读的。在软件生存期中,人们经常要阅读程序。特别是在软件测试阶段和维护阶段,编写程序的人和参与测试、维护的人都要阅读程序阅读程序是软件开发和维护过程中的一个重要组成部分,而且读程序的时间比写程序的时间还要多
程序设计风格 ” ◆ 程序不只是给机器执行的,也是供人阅读的。在 软件生存期中,人们经常要阅读程序。特别是在软件 测试阶段和维护阶段,编写程序的人和参与测试、维 护的人都要阅读程序。 ◆ 阅读程序是软件开发和维护过程中的一个重要组 成部分,而且读程序的时间比写程序的时间还要多
程序设计风格(1)源程序文档化源程序文档化包括标识符的命名、安排注释以及程序的视觉组织等1)标识符的命名标识符包括模块名、变量名、常量名、标号名、子程序名以及数据区名、缓冲区名等,这些名字应能反映它所代表的实际东西,使其能够见名知意,有助于对程序功能的理解
程序设计风格 ” (1)源程序文档化 源程序文档化包括标识符的命名、安排注释以及程 序的视觉组织等。 1)标识符的命名 标识符包括模块名、变量名、常量名、标号名、子 程序名以及数据区名、缓冲区名等,这些名字应能反映 它所代表的实际东西,使其能够见名知意,有助于对程 序功能的理解
程序设计风格2)程序的注释正确的注释能够帮助读者理解程序,为测试和维护提供明确的指导,注释绝不是可有可无的。注释分为序言性注释和功能性注释序言性注释通常置于每个程序模块的开头部分,它应当给出程序的整体说明,对于理解程序本身具有引导作用。功能性注释嵌入在源程序体中,用以描述其后的语句或程序段,也就是解释下面要“做什么”或是执行了下面的语句会怎么样
程序设计风格 ” 2)程序的注释 正确的注释能够帮助读者理解程序,为测试和维护提供 明确的指导,注释绝不是可有可无的。 注释分为序言性注释和功能性注释。 序言性注释通常置于每个程序模块的开头部分,它应当 给出程序的整体说明,对于理解程序本身具有引导作用。 功能性注释嵌入在源程序体中,用以描述其后的语句或 程序段,也就是解释下面要“做什么”或是执行了下面的语 句会怎么样
程序设计风格序言性注释做了明确而严格的规定,要程序编制者列出:①程序(模块)标题)②有关本模块功能和目的的说明;③主要算法;接口说明,包括调用形式、参数描述、子程序清单;
程序设计风格 ” 序言性注释做了明确而严格的规定,要程序 编制者列出: ① 程序(模块)标题; ② 有关本模块功能和目的的说明; ③ 主要算法; ④ 接口说明,包括调用形式、参数描述、子 程序清单;
程序设计风格③有关数据描述,包括重要的变量及其用途约束或限制条件,以及其他有关信息;③模块位置,说明在哪一个源文件中,或隶属于哪一个软件包②开发简历,包括模块设计者、复审者、复审日期、修改日期及有关说明等
程序设计风格 ” ⑤ 有关数据描述,包括重要的变量及其用途 、约束或限制条件,以及其他有关信息; ⑥ 模块位置,说明在哪一个源文件中,或隶 属于哪一个软件包; ⑦ 开发简历,包括模块设计者、复审者、复 审日期、修改日期及有关说明等