思政元素：代码编写注释约束。通过思政元素强化职业素养教育。

学生在掌握知识的同时，职业素养教育也是十分必要的，在进行项目开发时，所编写的代码一定要做到可读性强、可维护性强、高内聚、低耦合、增强移植性。代码编写格式的规范，体现着从业者的团队意识和职业素养。

在上一章我们进行了代码编写排版的约束讲解，本章我们通过讲解代码注释，提升程序的可读性和可维护性，进一步强化学生的团队意识。

（1）一般情况下，源程序有效注释量必须在20%以上。注释的原则是有助于对程序的阅读理解，注释不宜太多也不能太少，注释必须准确、易懂、简介。

（2）说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件、.cfg文件等）头部应进行注释，注释必须列出版权说明、版本号、生成日期、作者、内容、功能、与其他文件的关系、修改日志等，头文件的注释还应有函数功能简要说明。(www.daowen.com)

（3）函数头部应进行注释，列出函数的目的、功能、输入参数、输出参数、返回值、调用关系等。

（4）边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。无用的注释要删除。

（5）将注释与其上面的代码用空行隔开。

（6）对变量的定义和分支语句、条件语句、循环语句等必须编写注释。