源程序文档化 n标识符的命名 安排注释 n程序的视觉组织
源程序文档化 ◼ 标识符的命名 ◼ 安排注释 ◼ 程序的视觉组织
符号名的命名 ■符号名即标识符,包括模块名、变量名 常量名、标号名、子程序名、、数据区 名以及缓冲区名等。 ■这些名字应能反映它所代表的实际东西 应有一定实际意义。 ■例如,表示次数的量用Tmes,表示总量 的用 Total,表示平均值的用4erge,表 示和的量用Swm等
符号名的命名 ◼ 符号名即标识符,包括模块名、变量名、 常量名、标号名、子程序名、、数据区 名以及缓冲区名等。 ◼ 这些名字应能反映它所代表的实际东西, 应有一定实际意义。 ◼ 例如,表示次数的量用Times,表示总量 的用Total,表示平均值的用Average,表 示和的量用Sum等
符号名的命名 ■名字不是越长越好,应当选择精炼的意 义明确的名字。必要时可使用缩写名字 但这时要注意缩写规则要一致,并且要 给每一个名字加注释。同时,在一个程 序中,一个变量只应用于一种用途。 NEWBALANCE ACCOUNTS PAYABLE NBALAP
符号名的命名 ◼ 名字不是越长越好,应当选择精炼的意 义明确的名字。必要时可使用缩写名字, 但这时要注意缩写规则要一致,并且要 给每一个名字加注释。同时,在一个程 序中,一个变量只应用于一种用途。 ◼ NEW.BALANCE.ACCOUNTS.PAYABLE ◼ NBALAP ◼ N
程序的注程 夹在程序中的注释是程序员与日后 的程序读者之间通信的重要手段。 注释决不是可有可无的。 些正规的程序文本中,注释行的 数量占到整个源程序的1/3到1/2, 甚至更多。 注释分为序言性注释和功能性注释
程序的注释 ◼ 夹在程序中的注释是程序员与日后 的程序读者之间通信的重要手段。 ◼ 注释决不是可有可无的。 ◼ 一些正规的程序文本中,注释行的 数量占到整个源程序的1/3到1/2, 甚至更多。 ◼ 注释分为序言性注释和功能性注释
序言性注释(头文件) 通常置于每个程序模块的开头部 分,它应当给出程序的整体说明, 对于理解程序本身具有引导作用。 有些软件开发部门对序言性注释 做了明确而严格的规定,要求程 序编制者逐项列出
序言性注释(头文件) ◼ 通常置于每个程序模块的开头部 分,它应当给出程序的整体说明, 对于理解程序本身具有引导作用。 有些软件开发部门对序言性注释 做了明确而严格的规定,要求程 序编制者逐项列出