对python进行注释可以提高代码的规范,也能提高效率。这其中包括对函数、类等之间的快速的注释,另一方面包括对注释内容的规范书写。
python主要包括两部分:
一、是单行和多行的注释;
二、是代码的注释规则;
一、单行与多行注释
一、python单行注释符号(#)
其中"#"右边的内容不会输出,用于对单行注释。
使用的快捷键是:ctrl + ’/‘
二、批量、多行注释符号
在python中也会有注释有很多行的时候,这种情况下就需要批量多行注释符了。多行注释是用三引号包含的,例如:
使用方法:敲三个单引号或者双引号,回车即可出现如图中所示。
二、代码注释规则
代码注释规则中分为静态注释和动态注释。
一、静态注释-单行
单行中除了可以使用’#‘来对单行进行注释,也可以用如下图所示,来对返回的类型进行限制。
需要注意的是:使用# type:的方式,如果在不知道返回类型的情况下,也可以自动补全代码,但是并不会检查语法或者代码逻辑上的错误。
二、静态注释-多行
多行中的参数都有各自的意义,不同的变量代表着不同的功能,一般默认生成的为冒号加参数的形式 ”:param“ 在如下所示中,展示了各种不同的参数。
三、动态注释
动态注释仅限与python的3.多的版本。表现形式为:
def 函数名 -> 注释内容
注释内容一般用于包括 对参数的类型的表示,多个参数用小括号,注释内容用单引号或者双引号,具体各类如下所示:
1.单个参数
类型方式:
def 函数名(参数)->类型:
的方式,类型表示函数返回的参数类型。
2.多个参数
类型方式:
def 函数名(参数1,参数2,…)-> (参数1类型,参数2类型,…):
此时的注释是对函数的参数的类型的定义
或者如下
def 函数名(参数1,参数2,…)-> (参数1类型,参数2类型,…):->返回类型
3.注释内容
总结
对静态注释中的类型参数,例如:冒号加 参数type :type等参数还不是很了解,以后再逐步使用过程中会对博客不断加强补充。