程序员文章、书籍推荐和程序员创业信息与资源分享平台

网站首页 > 技术文章 正文

Python注释方式有哪些

hfteth 2024-12-13 11:56:41 技术文章 12 ℃

注释是对一段代码的解释和说明,可提高程序代码的可读性,让人们能够更加轻松地了解代码,尤其在大型项目开发和团队项目中,注释是必不可少的!

任何编程语言都少不了注释,Python也不例外,以下是Python注释的几种具体用法:

单行注释

  • 以 # 开头,#右边所有的东西都被当作说明文字,而不是真正要执行的程序,只是起到辅助说明作用。单行注释可以作为单独的一行放在被注释代码行之上,也可以放在语句或者表达式之后。

示例:

# 这是一个单行注释。
print("hello world!")   # 放置语句之后的注释。

注意:为了保证Python语句的美观,输入单行注释表示#之后,空一个空格,在继续输入注释内容。

多行注释

多行注释又称块注释,Python中多行注释使用三个单引号(’’’)或者三个双引号(”””)来标记,而实际上这是多行字符串的书写方式,并不是Python本身提倡的多行注释方法。

示例:

'''
这是一个多行注释,使用单引号。
这是一个多行注释,使用单引号。
 '''

"""
这是一个多行注释,使用双引号。
这是一个多行注释,使用双引号。
"""

注意:

  • 注释不是越多越好, 对于一幕了然的代码,不需要添加注释;
  • 对于 复杂的操作, 应该在操作开始前协商若干行注释;
  • 对于 不是一目了然的代码, 应该在其尾行添加注释,(为了提高可读性,注释至少应该离开代码2个空格);
  • 绝不要描述代码,假设阅读代码的人比你更懂Python,他只是不知道你的代码要做什么。

编码注释

在进行Python 2开发时,需进行编码声明,如采用UTF-8编码,需在源码上方进行 # -*- coding: UTF-8 -*- 声明,否则Python 2 会默认使用ASCII编码。

从Python3开始,Python默认使用UTF-8编码,所以Python3.x的源文件不需要特殊声明UTF-8编码。

# -*- coding: UTF-8 -*-

平台注释

如果需要使Python程序运行在Windows平台上,需在Python文件的上方加上 #!/usr/bin/python 注释说明。

Python注释除了可以起到说明文档的作用外,还可以进行代码的调试,将一部分代码注释掉,对剩余的代码进行排查,从而找出问题所在,进行代码的完善!

Tags:

最近发表
标签列表