Python 中写注释的方法

在写 Python 代码的时候，一个很好的编码实践就是使得你的代码简洁，易懂。组织代码，设置变量，以及给函数有意义的名字，都是几个不错的方法。

另外一个提高代码可读性的方式就是使用注释。一个注释就是可以用来解释代码的一段人类可读的解释或者一个注解。例如，如果你写了一个复杂的正则表达式，你可以添加一个注释，描述代码做了什么。

在你的 Python 代码中添加注释，在将来你阅读你的代码时，可以节省很多的时间和努力。比如说，你想修改一段你在几个月前或者几年前写的脚本。很可能你不记得为什么你写了一些比较复杂的代码，除非你添加一段注释。这个注释同时也可以帮助其他开发者理解你的代码，以及代码的目的。

注释应该很短，并且切中要点。不要解释那些很容易读懂的代码。

本文主要讲解在 Python 中编写注释的基础知识。

一、在 Python 中写注释

Python 会忽略井号(#)后面的一切。

注释可以添加到行首或者和其他代码在一行。

# This is a Python comment.
print("Hello World") # This is an inline Python comment.

井号后面的空格不是强制性的，但是它会提高注释的可读性。

在字符串中间的井号并不意味着是一段注释的开始。此时，它仅仅是一个简单的井号。

paragraph = "# Hash inside quotes is not a comment."

Comments should be at the same indent level as the code beneath it:

```py
def factorial(n):
 if n == 0:
  return 1
 else:
  # Use the factorial function
  return n * factorial(n-1)

如果你的文本编辑器支持语法高亮，注释通常都使用绿色代表。

注释在调试脚本的时候非常有用。与其删除一些行或者代码块，不如将他们暂时注释掉：

# for fruit in fruits:
#  print(fruit)

二、Python 中的多行注释(注释块)

不像其他流行的编程语言，Python 仅仅支持单行注释。

在 Python 中编写多行注释的最简单方式就是每行添加一个注释。

# This is the first line.
# This is the second line.

另外一个选项就是使用 docstrings

Docstrings 是一个多行字符串，用来对模块，函数，类和方法进行文档化的。

一个 Docstrings 以(""") 开始，可以是 一行或者多行：

"""This is
a multiline
docstring.
"""

Docstrings 不是技术性的注释。当 Docstrings 在模块，函数，类，或者方法的前面出现的时候，它在字节码中结束，并且变成__doc__特殊属性的对象。

你更应该使用单行注释。

三、Shebang

如果你阅读 Python 脚本，你可能注意到第一行以#!字符开始，接着是 Python 解释器的路径。

#!/usr/bin/env python3

这一串字符串被称为shebang,它被用来告诉操作系统，应该使用什么解释器来解析文件。脚本以 shebang 开头，并且可以在终端中直接运行，而不用在脚本输入python。

因为 shebang 以 井号开头，它被认为是一个注释，并且自动被 Python 解释器忽略。

四、总结

编写注释是一个非常好的实践，它帮助其他开发者，包括未来的自己，来理解这段代码在做什么。

在 Python 中，所有以井号开头的直到行末的，都被认为是一段注释。

以上就是Python 中写注释的方法的详细内容，更多关于python 注释的资料请关注我们其它相关文章！

赞 (0)

相关推荐

  • Python matplotlib绘制图形实例(包括点,曲线,注释和箭头)

    Python matplotlib绘制图形实例(包括点,曲线,注释和箭头)

    Python的matplotlib模块绘制图形功能很强大,今天就用pyplot绘制一个简单的图形,图形中包括曲线.曲线上的点.注释和指向点的箭头. 1. 结果预览: 2. 代码如下: from matplotlib import pyplot as plt import numpy as np # 绘制曲线 x = np.linspace(2, 21, 20) # 取闭区间[2, 21]之间的等差数列,列表长度20 y = np.log10(x) + 0.5 plt.figure() # 添加一

  • Python 添加文件注释和函数注释操作

    1.文件添加方式: pycharm提供了一个在新建文件自动生成文件头注释的功能,可以实现自动生成运行环境,作者.日期等必要信息,使用比较方便,配置十分简单. #!C:\pythonCode # -*- coding: utf-8 -*- # @Time : ${DATE} ${TIME} # @Author : hlx # @File : ${NAME}.py # @Software: ${PRODUCT_NAME} 2.自动生成函数注释,包括参数和返回值.使用方法,函数定义时,直接输入三个双引

  • python代码如何注释

    注释 注释就是对代码的解释和说明.目的是为了让别人和自己很容易看懂.为了让别人一看就知道这段代码是做什么用的.正确的程序注释一般包括序言性注释和功能性注释.序言性注释的主要内容包括模块的接口.数据的描述和模块的功能.模块的功能性注释的主要内容包括程序段的功能.语句的功能和数据的状态. 注释的分类 1.单行注释 以#开头,#右边的所有东西当做说明,而不是真正要执行的程序,起辅助说明作用 #我是注释,可以在这里写一下功能说明之类 print("我上面一行是对我的注释") 2.多行注释 多行

  • python快速编写单行注释多行注释的方法

    在python代码编写过程中,养成注释的习惯非常有用,可以让自己或别人后续在阅读代码时,轻松理解代码的含义. 如果只是简单的单行注释,可直接用"#"号开头,放于代码前面. 单行注释也可以跟代码同行,放在代码后面,以"#"号开头. 如果是多行注释,可在每行注释前面加"#"号. 多行注释,也可用3个双引号括起来. 多行注释,还可以用3个单引号括起来. 如需将现有的代码注释掉,可先选中需要注释的代码. 再按Ctrl + / ,这样选中的代码行前均会加上

  • Python之Matplotlib文字与注释的使用方法

    可视化对于大家来说确实是有关的,因为确实是直观的,每一组大数据如果可以用可视化进行展示的话可以让大家豁然开朗.但在另外一些场景中,辅之以少量的文字提示(textual cue)和标签是必不可少的.虽然最基本的注释(annotation)类型可能只是坐标轴标题与图标题,但注释可远远不止这些.让我们可视化一些数据,看看如何通过添加注释来更恰当地表达信息. 首先导入画图需要用到的一些函数: import matplotlib.pyplot as plt import matplotlib as mpl

  • Python爬虫库BeautifulSoup获取对象(标签)名,属性,内容,注释

    一.Tag(标签)对象 1.Tag对象与XML或HTML原生文档中的tag相同. from bs4 import BeautifulSoup soup = BeautifulSoup('<b class="boldest">Extremely bold</b>','lxml') tag = soup.b type(tag) bs4.element.Tag 2.Tag的Name属性 每个tag都有自己的名字,通过.name来获取 tag.name 'b' tag.

  • Python如何脚本过滤文件中的注释

    确保对模块, 函数, 方法和行内注释使用正确的风格,Python中的注释有单行注释和多行注释.如果希望去除文件中所有注释,如何做呢? Python中的注释: Python中单行注释以 # 开头,例如: # 这是一个注释 print("Hello, World!") 多行注释用三个单引号 ''' 或者三个双引号 """ 将注释括起来,例如: #!/usr/bin/python3 ''' 这是多行注释,用三个单引号 这是多行注释,用三个单引号 这是多行注释,用

  • Python中注释（多行注释和单行注释）的用法实例

    前言 学会向程序中添加必要的注释,也是很重要的.注释不仅可以用来解释程序某些部分的作用和功能(用自然语言描述代码的功能),在必要时,还可以将代码临时移除,是调试程序的好帮手. 当然,添加注释的最大作用还是提高程序的可读性!很多时候,笔者宁愿自己写一个应用,也不愿意去改进别人的代码,没有合理的注释是一个重要原因.虽然良好的代码可自成文挡,但我们永远也不清楚今后读这段代码的人是谁,他是否和你有相同的思路.或者一段时间以后,你自己也不清楚当时写这段代码的目的了. 总的来说,一旦程序中注释掉某部分内容,

  • Python代码注释规范代码实例解析

    一.代码注释介绍 注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码. 注释是编写程序时,写程序的人给一个语句.程序段.函数等的解释或提示,能提高程序代码的可读性. 在有处理逻辑的代码中,源程序有效注释量必须在20%以上. 二.代码注释分类 行注释:在符号后那一行不会被编译(显示) 块注释:被块注释符号中间的部分不会被编译 三.python代码注释基础 Python中使用#表示单行注释.单行注释可以作为单独的一行放在被注释代码行之上,也可以放在语句或表达式之后.如下例子: name

  • VSCode中自动为Python文件添加头部注释

    VSCode中自动为Python文件添加头部注释

    在实际编写Python文件时,往往需要为文件添加相关说明,例如文件名称.文件作用.创建时间.作者信息.版本号等等.这些信息往往是固定模板的,因此希望有一种方式可以自动的为我们添加上这些信息.下面介绍一种在VS Code中自动为python文件添加头部注释的方法. 依次单击菜单栏 "File"-"Preferences"-"User Snippets",然后选择python后会生成python.json文件,将该文件内容替换为以下内容: { &qu

随机推荐