【问题标题】:Difference between comments in Python, # and """Python 中的注释、# 和 """ 之间的区别
【发布时间】:2016-11-05 19:23:29
【问题描述】:

开始使用 Python 编程,我看到一些带有 cmets 的脚本使用 #""" comments """

这两种评论方式有什么区别?

【问题讨论】:

标签: python


【解决方案1】:

最好的办法是阅读 PEP 8 -- Style Guide for Python Code,但由于它很长,这里 是三线:

  • 注释以 # 开头,不是代码的一部分。
  • 字符串(由 """ """ 分隔)实际上被称为 docstring 并在特殊位置用于特定目的(简而言之:模块或函数中描述模块或函数的第一件事),实际上是可在代码中访问(因此它是程序的一部分;它不是注释)。

【讨论】:

    【解决方案2】:

    模块、类或函数开头的字符串是一个文档字符串:

    可以通过some_obj.__doc__ 访问并在help(...) 中使用。使用"Returns 42" 还是"""Returns 42""" 是一种风格问题,使用后一种更为常见,即使对于单行文档也是如此。

    # comment 就是这样,一个评论。它不能在运行时访问。

    【讨论】:

      【解决方案3】:

      三引号是一种创建多行字符串和/或注释的方法:

      """
      Descriptive text here
      """
      

      不分配给变量是一种无操作,某些版本的 Python 将完全忽略。 PEP 8 suggests when to use block comment/strings,我个人遵循这样的格式:

      Example Google Style Python Docstrings

      【讨论】:

        【解决方案4】:

        # 表示整行用于注释,而两个“””引号之间的任何内容都用作 cmets,因此您可以在多行上编写 cmets。

        【讨论】:

          【解决方案5】:

          正如用户在之前的回答中所说,三引号用于注释多行代码,而 # 仅包含一行。

          但请注意,因为您可以将三引号用于文档字符串等。

          【讨论】:

            猜你喜欢
            • 2012-06-25
            • 2015-05-08
            • 1970-01-01
            • 2016-12-28
            • 2017-07-05
            • 1970-01-01
            • 1970-01-01
            • 2012-07-21
            • 2011-12-20
            相关资源
            最近更新 更多