注释可以帮助读者去思考每个过程、每个函数、每条语句的含义,便于编程员的相互讨论,有利于程序的维护和调试。一般情况下,源程序中有效注释量占总代码量的20%以上。
程序的注释分为序言性注释和功能性注释。
(1)序言性注释:位于每个模块开始处,作为序言性的注解,简要描述模块的功能、主要算法、接口特点、重要数据以及开发简史。
(2)功能性注释:插在程序中间,与一段程序代码有关的注解,是针对一些必要的变量、核心的代码进行解释,主要解释包含这段代码的必要性。