1、源程序文档化
(1)标识符应按意取名。
(2)程序应加注释。注释是程序员与日后读者之间通信的重要工具,用自然语言或伪码描述。它说明了程序的功能,特别在维护阶段,对理解程序提供了明确指导。注释分序言性注释和功能性注释。序言性注释应置于每个模块的起始部分,主要内容有:
①说明每个模块的用途、功能。
②说明模块的接口:调用形式、参数描述及从属模块的清单。
③数据描述:重要数据的名称、用途、限制、约束及其他信息。
④开发历史:设计者、审阅者姓名及日期,修改说明及日期。
功能性注释嵌入在源程序内部,说明程序段或语句的功能以及数据的状态。注意以下几点:
①注释用来说明程序段,而不是每一行程序都要加注释。
②使用空行或缩格或括号,以便很容易区分注释和程序。
③修改程序也应修改注释。
2、数据说明原则
为了使数据定义更易于理解和维护,有以下指导原则:
(1)数据说明顺序应规范,使数据的属性更易于查找