头文件的内容 程序标题 有关本模块功能和目的的说明; 主要算法 接口说咀:包括调用形式,参数描述,子程序清单; 有关数据描述:重要的变量及其用途,约束或限制条 件,以及其它有关信息; 模块位置:在哪一个源文件中,或隶属于哪一个软件 开发简历:模块设计者,复审者,复审日期,修改日 期及有关说明等
头文件的内容 ◼ 程序标题； ◼ 有关本模块功能和目的的说明； ◼ 主要算法； ◼ 接口说明：包括调用形式，参数描述，子程序清单； ◼ 有关数据描述：重要的变量及其用途，约束或限制条 件，以及其它有关信息； ◼ 模块位置：在哪一个源文件中，或隶属于哪一个软件 包； ◼ 开发简历：模块设计者，复审者，复审日期，修改日 期及有关说明等
功能性注释 功能性注释嵌在源程序体中,用以描述 其后的语句或程序段是在做什么工作 或是执行了下面的语句会怎么样。而不 要解释下面怎么做。 例如, /R ADD AMOUNT TO TOTAL * TOTAL=AMOUNT +TOTAL 不好
功能性注释 ◼ 功能性注释嵌在源程序体中，用以描述 其后的语句或程序段是在做什么工作， 或是执行了下面的语句会怎么样。而不 要解释下面怎么做。 ◼ 例如， /* ADD AMOUNT TO TOTAL */ TOTAL = AMOUNT＋TOTAL 不好
功能性注释 ■如果注明把月销售额计入年度总额,便使读者 理解了下面语句的意图: A ADD MONTHLLYSALES TO ANNUAL TOTAL */ TOTAL=AMOUNT TOTAL 要点 描述一段程序,而不是每一个语句 用缩进和空行,使程序与注释容易区别 注释要正确
功能性注释 ◼ 如果注明把月销售额计入年度总额，便使读者 理解了下面语句的意图： /* ADD MONTHLY-SALES TO ANNUALTOTAL */ TOTAL = AMOUNT＋TOTAL ◼ 要点 ◼ 描述一段程序，而不是每一个语句； ◼ 用缩进和空行，使程序与注释容易区别； ◼ 注释要正确
视觉组织空格、空行和移行 怡当地利用空格,可以突出运算的优先 性,避免发生运算的错误。 例如,将表达式 (A<-17)ANDNOT(B< =49ORC 写成 (A<-17)AND NOT(B<=49)OR C 自然的程序段之间可用空行隔开
视觉组织—空格、空行和移行 ◼ 恰当地利用空格，可以突出运算的优先 性，避免发生运算的错误。 ◼ 例如 ，将表达式 (A＜－17)ANDNOT(B＜＝49)ORC 写成 (A＜－17) AND NOT (B＜＝49) OR C ◼ 自然的程序段之间可用空行隔开；
视觉组织 ■移行也叫做向右缩格。它是指程序中的各行不 必都在左端对齐,都从第一格起排列。这样做 使程序完全分不清层次关系。 对于选择语句和循环语句,把其中的程序段语 句向右做阶梯式移行。使程序的逻辑结构更加 清晰。 例如,两重选择结构嵌套,写成下面的移行形 式,层次就清楚得多
视觉组织 ◼ 移行也叫做向右缩格。它是指程序中的各行不 必都在左端对齐，都从第一格起排列。这样做 使程序完全分不清层次关系。 ◼ 对于选择语句和循环语句，把其中的程序段语 句向右做阶梯式移行。使程序的逻辑结构更加 清晰。 ◼ 例如，两重选择结构嵌套，写成下面的移行形 式，层次就清楚得多