Python文件头部规范、注释与省略内容杂记

发布时间 2023-04-01 02:18:23作者: XuShuo_Self

文件头部规范

Python相关文档(官方文档):2. Python 解释器 — Python 3.11.2 文档

  • 第一行(可选):#!/usr/bin/python#!/usr/bin/python3#!/usr/bin/env python#!/usr/bin/env python3

通常,以“#!”开头的代码行叫做 Shebang ,用于指定Linux、macOS等系统运行文件的终端。(Windows会自动忽略)

  • 第二行(可选,如果没有上述第一行的话就可以将此行作为文件第一行):

可以用类似# -*- coding: encoding -*-的形式指定编码,如使用# -*- coding: utf-8 -*-指定此文件的编码为UTF-8

注释

  • 单行注释:#。如下——
# 我是一个单行注释!
# Python解释器会自动跳过注释而并不会执行它!
  • 多行注释:''' '''""" """。如下——
'''
我是一个多行注释!
Python解释器会自动跳过注释而并不会执行它!
'''

"""
我是一个多行注释!
Python解释器会自动跳过注释而并不会执行它!
"""
  • 多行注释补充:多行注释只是一个名称,实际上,它也可以只写一行。如下——
''' 没想到吧!我还可以这样~ '''

""" 没想到吧!我还可以这样~ """

省略内容

  • pass常用于省略需要填写内容但并无可填内容的地方。如(如下定义一个空函数):
def func():
    pass
  • Ellipsis(“...”)与pass差不多,但它在IDLE界面有文字回显。相较pass来说,pass体现的是“永久空缺”,即以后不会修改此部分内容;但Ellipsis(“...”)表现的是“临时空缺”,即当前功能还未完善,待以后更新。如(如下定义一个空类):
class demo:
    ...
  • Ellipsis(“...”)补充:除此之外,“...”这个符号有时在某些特殊情况也会表示某个对象“它自己”,如下:
a = [1,2,3]
a[1] = a
print(a) # [1, [...], 3]