python3-注释与声明

1、单行注释

也称为行注释，使用字符#在注释内容前标注

• 单行注释可以是独占一行，也可以是在一行代码的尾端添加
• 单行注释一般与下一行代码同样的缩进，但是并不强制

2、多行注释

也称为块注释，使用成对三个单引号，或三个双引号标记

• 多行注释必须独占一行或多行，不能与代码并行
• 多行注释必须与下一行代码保持同样的缩进

3、文档注释

在类声明、方法或函数声明的下一行，使用多行注释，该部分会作为文档注释。

将类、方法或函数作为help函数的参数，会输出注释文档。

def insert():
    """插入"""
    return ''

print(help(insert))
"""
Help on function insert in module __main__:

insert()
    插入

None
"""

4、文档编码注释

默认情况下，python3源码文档是以utf-8编码保存，被python解释器支持。

也被称为中文编码注释，如果代码中包含中文，即使只是注释部分包含，也需要使用默认的utf-8编码或者显式声明支持中文的编码类型，比如utf-8、gbk

指定不同编码，在文档首行进行声明，告知python解释器如何读取。

# -*- coding: cp-1252 -*-

 另一种写法:(没有使用验证过)

#coding=utf-8
或者
#coding=gbk

 5、注解注释

"""
生产商品
:param name:商品名称
:param price:价格
:param count:数量
:return:
"""
def goods_producing(name: str, price: float, count: int):

• 这里的注解注释，指的是:param和:return等一套规范

6、路径指向

(1)在windows下可以不写，或者写了但并不会作用

(2)路径指向应用在linux环境中，以调用python 解释器。

#!/usr/bin/python3

第一行注释标的是指向 python 的路径，告诉操作系统执行这个脚本的时候，调用 /usr/bin 下的 python 解释器。

#!/usr/bin/env python3

推荐写法，这种用法先在 env（环境变量）设置里查找 python 的安装路径，再调用对应路径下的解释器程序完成操作。