专栏首页ITCoder如何在 Python 中注释

如何在 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 中,所有以井号开头的直到行末的,都被认为是一段注释。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • python代码如何注释

    注释就是对代码的解释和说明。目的是为了让别人和自己很容易看懂。为了让别人一看就知道这段代码是做什么用的。正确的程序注释一般包括序言性注释和功能性注释。序言性注释...

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

    确保对模块, 函数, 方法和行内注释使用正确的风格,Python中的注释有单行注释和多行注释。如果希望去除文件中所有注释,如何做呢?

    砸漏
  • python中的注释

        虽然#这个符号在python中表示注释,其实如果用pydev或者别的什么IDE来编写程序的时候,如果开头不声明保存编码格式,

    py3study
  • 如何在Windows中安装多个python解释器

    在windows10系统下安装两个不同版本的的python解释器,在通常情况下编译执行文件都是没问题的,但是加载或下载包的时候pip的使用就会出现问题,无法下载...

    砸漏
  • 如何在 Eclipse 中更改注释块的 @author 版权信息?

    我们在使用 IDE——Ecilpse 进行开发,需要注明版权信息的时候,如果不更改默认设置的话,在注释块 @author 的内容就是电脑系统默认的,例如下图所示...

    白鹿第一帅
  • 如何让java中的注释代码执行?

    原因:java编译器会处理unicode字符,\u000d以及\u000a 正好对应“\r”回车、“\n”换行,经过编译器处理后,等效于下面的代码:

    菩提树下的杨过
  • ANNOVAR 是如何注释 RS ID 的?

    使用 ANNOVAR 进行的一项常见任务就是将 dbSNP 标识符分配给 VCF 文件中的突变。我经常会遇到这样的问题,即 ANNOVAR 没有为特定突变分配 ...

    生信菜鸟团
  • pycharm如何一次注释多行

    我们知道在python里面注释一行用#,那么如果你有十行或者一百行需要注释掉怎么办?显然不能自己手动在每一行前面都加一个#。

    生信交流平台
  • 【DB笔试面试540】在Oracle中,如何列举某个用户下所有表的注释及列的注释?

    可以使用DBA_TAB_COMMENTS视图来查询表的注释,使用DBA_COL_COMMENTS视图来查询列的注释。它们的示例分别如下所示:

    小麦苗DBA宝典

扫码关注云+社区

领取腾讯云代金券