论良好的程序设计风格.pdfVIP

维普资讯 山西煤炭 管理干部学院学报 2005年第3期 论 良好的程序设计风格 王新萍 (山西综合职业技术学院，山西 太原 030006) 摘 要：程序员编码过程中应培养和形成 良好的编程习惯和编码风格 ，这是编写出易读、易维护 、高质量程序 的前提 。 关键词 ：程序；可读性；维护；编码原则 中图分类号：TP311 文献标识码：A 文章编号：1008—8881f2005)03—0113—02 有经验的程序员认为 ，编写程序与作家写小说散文有相 (2)在限制变量名长度的语言中，标识符的名字可能要缩 似之处。作家写出的文章是给读者看的，程序员编写的程序 写 ，要注意缩写规则一定要一致，并且要给每一个名字加注 也是要供人阅读的。作家写文章时喜欢和习惯使用 自己的一 释 。 套风格来突出他的特点，但是如果不同的程序员编程序时也 2．适当的注解 都使用 自己的特殊风格 ，那么这个程序对其他人来说则可能 注解是程序员和程序读者通信的重要手段 ，正确的注解 是不可思议的。因此，非常有必要建立～套程序员和程序阅 非常有助于对程序的理解。注解分为序言性注解和功能性注 读者公认的编码原则 ，即程序设计风格。程序员遵循这些原 解。序言性注解通常置于每个程序模块 的开头部分 ，它应当 则编程序，则程序的正确性、有效性 、可读性、易维护性将会得 给出程序的功能说明、接 口描述 、对有关数据的描述、开发历 到保证。 史的描述等，对于理解程序本身具有引导作用。一个大型的 软件系统一般都是由许多人同时并行编码的，分配的原则是 一 、 程序 内部的文档 以模块为单位。为了便于测试、维护、人与人 (小组与小组)之 程序内部的文档包括恰 当的标识符、适当的注解和程序 间的通信，为每个模块编写序言性注解是非常必要 的。功能 的视觉组织等。 性注解嵌在源程序内部 ，用以描述某条语句或程序段是在做 1．恰当的标识符 什么工作，或是执行了下面语句会怎么样。但要注意不要用 标识符是指在程序设计时所定义的一些文件名、变量名 注解的形式将每个语句翻译成 自然语言。注解要正确 ，错误 等。一定要选取含义鲜明的名字，使这些名字能恰如其分地 的或容易引起误解的注解还不如没有注解。 表达出所代表的程序对象的含义，这对于帮助阅读者理解程 3．程序的视觉组织 序是很重要的。例如 ，表达式a：b+C中变量名 a、b、C让人不 即程序清单的布局。 能见名知义，而表达式 price=cost+profit中变量名就很直观 (1)在程序中使用空白行来分隔程序的节、段等 自然单位 地表达了等式的含义，意思是 ：价格等于成本加利润。再如表 或语句组 ，以增强程序的外观。 示和的变量名用SLLrll，表示总量的变量名用 total等。注意： (2)程序中好的语句位置可以使程序层次分明，逻辑结构 (1)标识符不要和所用程序设计语言的保留字相 同。有 清晰 。 的程序设计语言没有保留字，程序员可以使用任何名字作为 许多语言允许一行写多条语句，但这样会降低程序的可 变量名。在这种情况下，选择变量名更应注意。例如，在 PL／ 读性。例如，有这样一段 C语言程序 ： l中有这样语句 ：