第12章-程序设计语言和编码.ppt

源程序文档化 在源程序中可包含一些内部文档，以帮助阅读和理解源程序 在源程序中的内部文档主要包括： 标识符的命名 注解 程序的视觉组织 * 标识符的命名 选择含义明确的名字，使其能正确提示标识符所代表的实体 例如，表示总量的变量名用Total，表示平均值的用Average等 名字不要太长，太长会增加打字量，且易出错。必要时可使用缩写 不用相似的名字，相似的名字容易混淆，不易发现错误 如cm,cn,cmn,cnm,cnn,cmm * 不用关键字作标识符 同一个名字不要有多个含义 名字中避免使用易混淆的字符。如数字0与字母O； 数字1与字母I或l； 数字2与字母z等 * 程序的注释 程序中的注解用来帮助人们理解程序，决不是可有可无的 一些正规的程序文本中，注解行的数量约占整个源程序的1／3到1／2，甚至更多 注解分为序言性注解和功能性注解 * 通常置于每个程序模块的开头部分，主要描述： 模块的功能 模块的接口：包括调用格式、参数的解释、该模块需要调用的其它子模块名 重要的局部变量：包括用途、约束和限制条件 开发历史：包括模块的设计者、评审者、评审日期、修改日期以及对修改的描述 序言性注释 * 通常嵌在源程序体内，主要描述程序段的功能。 书写功能性注解时应注意的问题： 注解要正确，错误的注解比没有注解更坏； 为程序段作注解，而不是为每一个语句作注解； 用缩进和空行，使程序与注释容易区分； 注解应提供一些从程序本身难以得到的信息，而不是语句的重复。 功能性注释 * 例如，下面的模块级注释描述了公共的和私有的过程（在类模块中称为“方法”）、属性及其数据类型，以及如何将该类作为对象来使用的有关信息： 公共方法： MailAddRecipient(strName As String, Optional fType As Boolean) strName: //要加入到邮件中的收件人名称。 fType: Outlook MailItem Type //属性设置。 SendMail(Optional blnShowMailFirst As Boolean) blnShowMailFirst: //发送前是否显示 Outlook邮件信息。如果不能解析收件人的地址，让代码将它设置为 True。 私有方法： InitializeOutlook() CreateMail() 公共属性： MailSubject:(Write only, String) MailMessage:(Write only, String) MailAttachments:(Write only, String) * 通过在程序中添加一些空格、空行和缩进等技巧，帮助人们从视觉上看清程序的结构 例如，通过缩进技巧可清晰地观察到程序的嵌套层次，同时还容易发现诸如“遗漏end”那样的错误 视觉组织 * IF（…） THEN IF（…） THEN …… ELSE …… ENDIF ……ELSE ……ENDIF * 自然的程序段之间可用空行隔开 可通过添加空格使语句成分清晰，如(A＜－17)ANDNOT(B＜＝49)ORC可写成(A＜－17) AND NOT (B＜＝49) OR C 也可以通过添加括号突出运算的优先级，避免发生运算的错误，如 a**( b**c ) * 放置大括号 一般首选的方法是KR方法：把左括号放在行尾，右括号放在行首。如： if?(X)?{ Y } 定义函数时应当把左右括号都放在行首，如： int?F(int?x) { // } 注意，右括号所在的行不应当有其它语句，除非跟随着一个条件判断。也就是do-while语句中的“while”和if-else语句中的“else”。例如： do?{ body?of?do-loop }?while?(condition); if?(x?==?y)?{ … }?else?if?(x??y)?{ ... //p244 }? else?{ … } // end if (x==y) * 数据说明 为了使程序中数据说明更易于理解和维护，可采用以下风格： 数据说明的次序应当规范化 说明语句中变量安排有序化 使用注解说明复杂数据结构 * 数据说明的次序应当规范化 数据说明次序规范化，使数据属性容易查找，也有利于测试，排错和维护 原则上，数据说明的次序