程序的可读性对于软件的质量有重要影响,因此在程序设计过程中应当充分重视。为了提高程序的可读性,在程序设计风格方面应注意以下几点:
1.适当的程序注释
程序中适当地加上注释后,可以使程序成为一篇“自我解释”的文章,读程序时就不必翻阅其他说明材料了。注释原则上可以出现在程序中的任何位置,但是如果注释和程序的结构配合起来则效果更好。
注释一般分为序言性注释和描述性注释两类。
序言性注释出现在模块的首部,内容包括模块功能说明,界面描述(如调用语句格式、所有参数的解释和该模块需调用的模块名等),某些重要变量的使用、限制,开发信息如作者、复查日期、修改日期等。描述性注释嵌在程序之中,用来说明程序段的功能或数据状态。
如果详细设计是用工程设计语言(PDL)描述的,则编程时可将PDL描述嵌在程序中。
书写注释时应注意:
(1)注释应和程序一致,修改程序时应同时修改注释,否则会起反作用,使人更难明白。(www.xing528.com)
(2)注释应提供一些程序本身难以表达的信息。
(3)为了方便用户今后维护,注释要尽量多用汉字。
2.有规律的程序书写格式
恰当的书写格式将有助于阅读,在结构化程序设计中一般采用 “缩排法”来写程序,即把同一层次的语句行左端对齐,而下一层的语句则向右边缩进若干格书写,它能体现程序逻辑结构的深度。此外,在程序段与段之间安排空白行,也有助于阅读。
3.恰当选择变量名
理解程序中每个变量的含义是理解程序的关键,所以变量的名字应该适当选取,使其直观,易于理解和记忆,例如采用有实际意义的变量名、不用过于相似的变量名、同一变量名不要具有多种意义等。此外,在编程前最好能对变量名的选取约定统一标准,以后阅读理解就会方便得多。
免责声明:以上内容源自网络,版权归原作者所有,如有侵犯您的原创版权请告知,我们将尽快删除相关内容。