python中注释的作⽤_Python注释的⽤法详解
Python中注释（多⾏注释和单⾏注释）的⽤法实例
前⾔
学会向程序中添加必要的注释，也是很重要的。注释不仅可以⽤来解释程序某些部分的作⽤和功能（⽤⾃然语⾔描述代码的功能），在必要时，还可以将代码临时移除，是调试程序的好帮⼿。
当然，添加注释的最⼤作⽤还是提⾼程序的可读性！很多时候，笔者宁愿⾃⼰写⼀个应⽤，也不愿意去改进别⼈的代码，没有合理的注释是⼀个重要原因。虽然良好的代码可⾃成⽂挡，但我们永远也不清楚今后读这段代码的⼈是谁，他是否和你有相同的思路。或者⼀段时间以后，你⾃⼰也不清楚当时写这段代码的⽬的了。
总的来说，⼀旦程序中注释掉某部分内容，则该内容将会被 Python 解释器忽略，换句话说，此部分内容将不会被执⾏。
通常⽽⾔，合理的代码注释应该占源代码的 1/3 左右。Python 语⾔允许在任何地⽅插⼊空字符或注释，但不能插⼊到标识符和字符串中间。
在 Python 中，通常包括 3 种类型的注释，分别是单⾏注释、多⾏注释和中⽂编码声明注释。
Python单⾏注释
Python 中使⽤井号（‘#'）作为单⾏注释的符号，语法格式为：
# 注释内容
也就是说，从符号‘#'处开始，直到换⾏处结束，此部分内容都作为注释的内容，当程序执⾏时，这部分内容会被忽略。
单⾏注释放置的位置，既可以是要注释代码的前⼀⾏，例如：
#这是⼀⾏简单的注释
print ("Hello World!")
也可以是注释代码的右侧，例如：
print ("Hello World!") #这是⼀⾏简单的注释
基于注释在程序中所起到的作⽤，以上两种⽅式虽然放置位置不同，但程序的执⾏结果是相同的，都是输出“Hello World!”。
Python多⾏注释
多⾏注释指的是可以⼀次性注释程序中多⾏的内容（包含⼀⾏）。多⾏注释的语法有 2 种，分别是：
'''
使⽤ 3 个单引号分别作为注释的开头和结尾
可以⼀次性注释多⾏内容
这⾥⾯的内容全部是注释内容
'''
或者
"""
使⽤ 3 个双引号分别作为注释的开头和结尾
可以⼀次性注释多⾏内容
这⾥⾯的内容全部是注释内容
"""
多⾏注释通常⽤来为 Python ⽂件、模块、类或者函数等添加版权、功能描述等信息。需要注意的是，在 Python 中，如果多⾏注释标记（三单引号或三双引号）作为语句的⼀部分出现，就不能再将它们视为多⾏注释的标记，⽽应看做是字符串的标志（同双引号的作⽤相同），例如：
print('''Hello,World!''')
该语句的执⾏结果为：Hello，World!。由此可见，Python 解释器没有将这⾥的三个单引号看做是注释，⽽是将它们看作是字符串的标志。
Python中⽂编码声明注释
Python 还提供了⼀种特殊的中⽂编码声明注释，其主要⽤来解决 Python 2.x 中不⽀持直接写中⽂的问题。虽然此问题在 Python 3.x 中已经不存在啦，但为了规范编码，增强代码的可执⾏性，⽅便其他程序员及时了解程序所⽤的编码，建议初学者在程序开头处加上中⽂编码声明注释。
中⽂编码声明注释的语法有如下 2 种：
# -*- coding：编码 -*-
或者
# coding=编码
语法中的编码，指的是编写程序所⽤的字符编码类型，⽐如 UTF-8、GBK 编码等。另外，在第⼀种语法中，‘-*-'并没有实际意义，只是为了美观才加上去了，因此，第⼀种语法格式中可以直接将前后的‘-*-'去掉。
举个例⼦，如果指定编码为 UTF-8，则可以使⽤下⾯的中⽂编码声明注释：
# coding:utf-8
或者
# coding=utf-8
注意，给代码添加注释是是注释的基本⽤法，它还有⼀个更实⽤的功能，即⽤来调试程序。举个例⼦，如果你觉得某段代码可能有问题，可以先把这段代码注释起来，让 Python 解释器忽略这段代码，
然后运⾏。如果程序可以正常执⾏，则可以说明错误就是由这段代码引起的；反之，如果依然出现相同的错误，则可以说明错误不是由这段代码引起的。
由此可见，在调试程序时，学会注释代码，可以缩⼩错误所在的范围，提⾼调试程序的效率。
总结
以上就是这篇⽂章的全部内容了，希望本⽂的内容对⼤家的学习或者⼯作具有⼀定的参考学习价值，谢谢⼤家对码农之家的⽀持。
python中文文档
详解Python3注释知识点
Python3 注释
确保对模块, 函数, ⽅法和⾏内注释使⽤正确的风格
Python中的注释有单⾏注释和多⾏注释：
Python中单⾏注释以 # 开头，例如：：
# 这是⼀个注释
print("Hello, World!")
多⾏注释⽤三个单引号 ''' 或者三个双引号 """ 将注释括起来，例如:
1、单引号（'''）
#!/usr/bin/python3
'''
这是多⾏注释，⽤三个单引号
这是多⾏注释，⽤三个单引号
这是多⾏注释，⽤三个单引号
'''
print("Hello, World!")
2、双引号（"""）
#!/usr/bin/python3
"""
这是多⾏注释，⽤三个双引号
这是多⾏注释，⽤三个双引号
这是多⾏注释，⽤三个双引号
"""
print("Hello, World!")
读者笔记
以下实例我们可以输出函数的注释：
def a():
'''这是⽂档字符串'''
pass
print(a.__doc__)
输出结果为：
这是⽂档字符串
以上就是本次给⼤家分享的关于java的全部知识点内容总结，⼤家还可以在下⽅相关⽂章⾥到相关⽂章进⼀步学习，感谢⼤家的阅读和⽀持。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。