c语言注释要点

C语言注释简介：
注释应该出现在三种位置

• 文件头部
• 函数头部
• 函数体内的和代码混在一起的注释

对于文件头部的注释至少列出：
版权声明、版本号、文件创建日期、作者、内容/功能、与其他文件的关系、修改日志等。

函数头部注释要求至少列出：
函数功能、输入/输出参数、返回值、调用/被调用关系等。

注意点：

• 对于放在代码上方的注释有时还会和上方其他代码用一个空行隔开
• 全局变量应减少使用，必须使用时要有详细的注释。包括功能/作用、取值范围、调用者、注意事项等
• 标识符、关键字之间必须至少加一个空格以示间隔
• 功能上相对独立的程序块之间加一个空行
• 对于过长的语句，应该从低优先级运算符处拆分成多行
• 对于长表达式，应该从低优先级运算符处拆分成多行
• 如果函数参数过长，也要拆分