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

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

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

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

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

建议1. 将不变条件的计算移到循环体外。 说明：将循环中与循环无关，不是每次循环都要做的操作，移到循环外部执行。 示例一： for (int i...

在C语言中，“通过对数据结构、程序算法的优化来提高效率”的核心思想是：通过选择更合适的数据结构和更高效的算法，减少程序的时间复杂度（执行速度）和...

本章节后面所有的规则和建议，都应在不影响可读性等质量属性的前提下实施。 说明：不能一味地追求代码效率，而对软件的正确、简洁、可维护性、可靠性及可...