|
本文介绍编写Python注释的基础，适用在Linux操作系统平台中。
前言 在编写Python代码时，始终使代码干净且易于理解是一个好习惯。 组织代码，给变量和函数提供描述性名称是实现此目的的几种方法。 提高代码可读性的另一种方法是使用注释，注释是人类可读的解释或注释，用于解释代码，例如，如果您编写了一个复杂的正则表达式，则会添加一条注释来描述代码的作用。 在将来查看代码时，在Python代码中添加注释将节省大量时间和精力，假设您要更改几个月或几年前编写的脚本，除非您添加注释，否则您将不记得为什么编写了一些复杂的代码，这些注释还可以帮助其他开发人员了解您的代码及其用途。 同时语言应该简短明了，不要解释对读者显而易见的内容。 相关参考：用Bash脚本编写注释：Bash选写注释及Bash中的多行注释方法。
编写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. 另一种选择是使用文档字符串。 文档字符串是多行字符串文字，用于记录模块、函数、类或方法的功能。 一个文档字符串以三重双引号（"""）开头和结尾，并且可以跨越一行或多行： """This is a multiline docstring. """ Docstrings从技术上讲不是注释，当文档字符串作为模块、函数、类或方法中的第一条语句出现时，它最终以字节码结尾，并成为该对象的__doc__特殊属性，您应该更喜欢使用常规的单行哈希注释。
Shebang 如果您正在阅读Python脚本，则可能会注意到其中一些第一行以#!开头，字符和Python解释器的路径： #!/usr/bin/env python3 此字符序列称为shebang，用于告诉操作系统使用哪个解释器来解析文件的其余部分，以shebang开头且可执行的脚本可以在终端中运行，而无需在脚本名称前键入python。 由于shebang行以井号字符开头，因此它被视为注释，并被Python解释器自动忽略。
结论 编写注释是一种好习惯，并且可以帮助其他开发人员（包括将来的自己）理解代码的作用，在Python中，井号（#）之后直至行尾的所有内容均视为注释。
相关主题 |
