建议1.函数声明处注释描述函数功能、性能及用法，包括输入和输出参数、函数返回值、可重入的要求等；定义处详细描述函数功能和实现要点，如实现的简要步...

对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case...

注释应放在其代码上方相邻位置或右方，不可放在下面。如放于上方则需与其上面的代码用空行隔开，且与下方代码缩进相同。 示例： /* active s...

全局变量要有较详细的注释，包括对其功能、取值范围以及存取时注意事项等的说明。 示例： /* The ErrorCode when SCCP tr...

文件头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者姓名、工号、内容、功能说明、与其它文件的关系、修改日志等，头文件的注释中还应有...

修改代码时，维护代码周边的所有注释，以保证注释与代码的一致性。不再有用的注释要删除。 说明：不要将无用的代码留在注释中，随时可以从源代码配置库中...

说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。 对于实现代码中巧妙的、晦涩...

说明：有歧义的注释反而会导致维护者更难看懂代码，正如带两块表反而不知道准确时间。 示例：注释与代码相矛盾，注释内容也不清楚，前后矛盾。 /* 上...

说明：优秀的代码不写注释也可轻易读懂，注释无法把糟糕的代码变好，需要很多注释来解释的代码往往存在坏味道，需要重构。 示例：注释不能消除代码的坏味...