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

源程序文档化 在源程序中可包含一些内部文档，以帮助阅读和理解源程序 在源程序中的内部文档主要包括： 标识符的命名 注解 程序的视觉组织 * 标识符的命名 选择含义明确的名字，使其能正确提示标识符所代表的实体 例如，表示总量的变量名用Total，表示平均值的用Average等 名字不要太长，太长会增加打字量，且易出错。必要时可使用缩写 不用相似的名字，相似的名字容易混淆，不易发现错误 如cm,cn,cmn,cnm,cnn,cmm * 不用关键字作标识符 同一个名字不要有多个含义 名字中避免使用易混淆的字符。如数字0与字母O； 数字1与字母I或l； 数字2与字母z等 * 程序的注释 程序中的注解用来帮助人们理解程序，决不是可有可无的 一些正规的程序文本中，注解行的数量约占整个源程序的1／3到1／2，甚至更多 注解分为序言性注解和功能性注解 * 通常置于每个程序模块的开头部分，主要描述： 模块的功能 模块的接口：包括调用格式、参数的解释、该模块需要调用的其它子模块名 重要的局部变量：包括用途、约束和限制条件 开发历史：包括模块的设计者、评审者、评审日期、修改日期以及对修改的描述 序言性注释 * 通常嵌在源程序体内，主要描述程序段的功能。 书写功能性注解时应注意的问题： 注解要正确，错误的注解比没有注解更坏； 为程序段作注解，而不是为每一个语句作注解； 用缩