
Python中的注释有很多种,包含单行注释、多行注释、批量注释以及中文注释等。Python注释也有自己的规范,注解可以起到一个备注的作用,团队亩正含合作的时候,个人编写的代码经常会被多人调用,为了让别人更容易理解代码的通途,使用注释是非常有用且有效的
// 表示这一行//后面的内容羡亏注源贺释掉
/* 表示下一个*/之前的内容注释掉
#include <stdio>兄裂神 //这是注释int main(){
return 0
/* 这都是注释
这都是注释
这都是注释
这都是注释*/
}
有两种注释方法:帆伍
// 行注释,可以注释其后的一行。
/* */ 块注释,注释这两个符号中间的所有区域。
【释的原则】
注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。 示例:如下注释意义态橡或不大。
/* if receive_flag is TRUE */
if (receive_flag)
而如下的注释则给出了额外有用的信息。
/* if mtp receive a message from links */
if (receive_flag)
【说明性文件头部应进行注释】
说明性文件(如头文件.h 文件、.inc 文件、.def 文件、编译说明文件.cfg 等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
【源文件头部应进行注释】
源文件头部应进行注释,列出如陵:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
【函数头部应进行注释】
函数头部应进行注释,列出:函数的目的/ 功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
示例1:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
欢迎分享,转载请注明来源:内存溢出
微信扫一扫
支付宝扫一扫
评论列表(0条)