Python基础之注释的用法-巨人网络通讯

主页 > 知识库 > Python基础之注释的用法

Python基础之注释的用法

前言

Python代码的基本规范如下：

1、Python 文件将以 .py 为扩展名。

2、在Python中严格区分大小写（大小写敏感），如果写错了大小写，程序会报错。

3、Python中的每一行就是一条语句，每条语句以换行结束，不用;分号结束。

4、Python是缩进严格的语言，所以在Python中不要随便写缩进。

缩进的好处是强迫你写出缩进较少的代码，你会倾向于把一段很长的代码拆分成若干函数，从而得到缩进较少的代码。
缩进的坏处就是复制－粘贴功能失效了，当你重构代码时，粘贴过去的代码必须重新检查缩进是否正确。

5、一条语句可以分多行编写，多行编写时语句后边以\结尾。

6、Python中每一行语句不要过长（规范中建议每行不要超过80个字符）。

扩展：

Python中文文档地址：https://docs.python.org/zh-cn/3/index.html。关于代码规范：
Python 官方提供有一系列 PEP（Python Enhancement Proposals）文档，其中第 8 篇文档专门针对 Python 的代码格式给出了建议，也就是俗称的 PEP 8。
文档地址：https://www.python.org/dev/peps/pep-0008/。

一、注释的作用

通过使用自己熟悉的语言，在程序中提示或解释某些关键代码的思路、作用和功能等，能够大大增强程序的可读性。（代码的可读性是非常重要的）

代码注释效果如下图：

没有添加注释的代码。

添加注释的代码。

二、注释的分类

注释分为两类：单行注释和多行注释。

单行注释

#作为单行注释的符号。只注释一行内容，语法如下：

# 注释内容

多行注释

可以注释多行内容，常用来为 Python 函数、类、模块等等添加功能、版本和作者等描述信息，语法如下：

#写法一：一对三双引号
"""
  第一行注释
  第二行注释
  第三行注释
"""

#写法二：一对三单引号
'''
  注释1
  注释2
  注释3
'''

三、注释的注意事项

Python 解释器（Python Interpreter）在执行程序（代码）时会忽略注释部分，不做任何处理。
当Python解释器解析Python文件的时候，一旦发现出现了#，就会认为#右边的文字全部都是说明性的文字，Python的解释器会直接跳过这一行，解释下一行代码。

极简单的注释可以放到一行代码的后面，一般习惯代码后面添加两个空格，再书写注释文字。

print('hello Python')  # 输出

#号和注释之间需要加上一个空格，不是强制，是规范。

Python 多行注释不支持嵌套，如下所示为错误写法：

'''
外层注释
    '''
    内层注释
    '''
'''

多行注释符号'''或"""也可以作为字符串的开始和结束标记。
Python 中当多行注释符号作为字符串的一部分出现时，就不能再将它们当做多行注释标记，而应该看做是字符串的一部分，如下所示：

#方式一
print("hello world ! hello python !")
print('hello world !')
print("""真香""")
print('''是真的''')

#方式二
str1 = "hello world ! hello python !"
str2 = 'hello world !'
str3 = """真香"""
str4 = '''是真的'''
print(str1)
print(str2)
print(str3)
print(str4)

"""
#执行结果都是
hello world ! hello python !
hello world ! 
真香
是真的
"""