��
(1) 序言性注释
��通常置于每个程序模块的开头部分,它应当给出程序的整体说明,对于理解程序本身具有引导作用。有些软件开发部门对序言性注释做了明确而严格的规定。
��要求程序编制者逐项列出的有关项目包括:程序标题、有关本模块功能和目的的说明、主要算法、接口说明、有关数据描述、模块位置、开发简历等。
(2) 功能性注释
��功能性注释嵌在源程序体中,用以描述其后的语句或程序段是在做什么工作,也就是解释下面要"做什么",或是执行了下面的语句会怎么样。而不要解释下面怎么做,因为解释怎么做常常是与程序本身重复的,并且对于阅读者理解程序没有什么帮助。例如,
/* ADD AMOUNT TO TOTAL */
TOTAL = AMOUNT+TOTAL
��这样的注释行仅仅重复了后面的语句,对于理解它的工作并没有什么作用。如果注明把月销售额计入年度总额,便使读者理解了下面语句的意图:
/* ADD MONTHLY-SALES TO ANNUAL-TOTAL */
TOTAL = AMOUNT+TOTAL
��