新闻动态
面向对象程序设计风格
http://sytm.net 发布日期:2014/1/23 14:53:37

源程序不仅是给机器执行的,也是供人阅读的。在软件生命周期中,人们经常要阅读程序。特别是在软件测试和维护阶段,编写程序的人和参与测试、维护的人都要阅读程序。因此,阅读程序是软件开发和维护过程中的一个重要组成部分,而且程序的可读性对于程序员理解程序的程度也起到重要的作用。因此,程序类似于一种工人阅读的文章。既然如此,就有一个文章的风格问题。

源程序文档化

源程序文档包括标示符的命名、安排注释以及程序的视觉组织等内容。

标示符名字不是越长越好,过长的名字会增加程序员或操作员的工作量,给修改带来困难。所以精炼的、意义明确的名字,对简化程序,增强程序的可理解性有重要的意义。在必要的时候,标示符的命名可使用缩写,但这时要注意与缩写规则一致,并且要给每个名字加注释。同时,在一个程序中,一个变量只应用于一种用途。例如在某种程序中定义了变量temp,它在程序的前半段代表温度,在程序的后半段代表零时变量,这样就会读者阅读造成混乱。

2.程序注释

正确的注释能够帮助读者李姐程序,为测试和维护提供明确地指导,注释绝不是可有可无的。大多数程序设计语言使用自然语言来写注释,这就给阅读程序带来了很大的方便。一些正归的程序文本中,注释行的数量占到整个源代码的1/3或1/2。

注释分为序言性注释和功能性注释。序言性注释通常置于每一个程序模块的开头部分,它应当给出程序的整体说明,对于理解程序本身具有引导作用。有些软件开发部门对序言性注释做了明确地规定,要求程序编制者逐项列出。有关项包括:

(1)程序(模块)标题。

(2)有关本模块功能和目的的说明。

(3)接口说明。

(4)有关数据描述,包括设计者、复审者、复审日期、修改日期及有关说明等。

功能型注释嵌在程序体中,用以描述语句或程序段要“做什么”,或是执行该语句的结果,而不是解释怎么做。因为描述怎么做往往与程序本身是重复的,并且对于阅读者理解程序没有什么帮助。例如,下面的注释仅仅重复了后面的语句,对于理解它的工作并没有什么作用。

/*Add amount to total*/

total=amount+total;

书写功能性注释,要注意以下几点:

(1)用于描述一段程序,而不是每一个语句。

(2)注释要正确。

有合适的、有助于记忆的标识符合恰当的注释,就能得到比较好的源程序内部的文档。有关设计的说明也可以作为注释嵌入到源程序内部。

3.视觉组织

一个程序如果写的密密麻麻分不出层次来,常常很难看懂。应该利用空格、空行和移行组织程序的视觉结构。

空格:恰当利用空格,可以突出运算的优先性,避免发生运算错误。

例如将表达式(a<-17)&&!(b<=49)||c写成:(a<-17)&&!(b<=49)||c就清楚。

空行:自然的程序段之间可用空行隔开。

移行:移行也叫做向右缩进。它是指程序中的各行不必都左端对齐,都从第一格起排列。因为这样做事程序完全分不清层次关系。因此,对于选择语句和循环语句,把其中的程序段语句向右做阶梯式移行。这样可使程序的逻辑结构更加清晰,层次更加分明。例如,两重选择结构嵌套,写成下面的移行形式,层次就清楚得多。

if(...)

 if(...)

 {

        ...

}

else

{

         ...

}

else

{

         ...

}


更多阅读
返回列表
© 2010 TianMei Technology All rights reserved. ICP:辽B-2-4-20100065辽公网安备 21010202000010号  网站地图