如何在python代码中写注释

Python单行注释

Python 中使用井号（‘#’）作为单行注释的符号，语法格式为：

# 注释内容

也就是说，从符号'#'开始，到换行符结束，这部分内容作为注释的内容，在程序执行时会忽略这部分内容。

单行注释的位置可以是要注释的代码的上一行，例如：

#这是一行简单的注释
print ("Hello World!")

也可以是注释代码的右侧，例如：

print ("Hello World!") #这是一行简单的注释

基于注释在程序中的作用，虽然上述两种方法的放置位置不同，但程序的执行结果是一样的，都是输出“Hello World！”。

Python多行注释

多行注释是指在一个程序中一次注释多行（包括一行）的能力。多行注释有两种语法：

'''
使用 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