有两种注释方法://行注释,可以注释其后的一行。/**/块注释,注释这两个符号中间的所有区域。【释的原则】注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。示例:如下注释意义不大。/*ifreceive_flagisTRUE*/if(receive_flag)而如下的注释则给出了额外有用的信息。/*ifmtpreceiveamessagefromlinks*/if(receive_flag)【说明性文件头部应进行注释】说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。【源文件头部应进行注释】源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。【函数头部应进行注释】函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。示例1:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
阅读全文 >