确保对模块, 函数, 方法和行内注释使用正确的风格
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=编码
更多技术请关注。