清华学姐教你如何在 Python 中编写注释和多行注释

Posted 2021-08-31 编程界的小胖子

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了清华学姐教你如何在 Python 中编写注释和多行注释相关的知识，希望对你有一定的参考价值。

注释就像路标，它使给定的代码不言而喻且具有高度可读性。在 Python 中，我们可以添加单行和多行 Python 注释。本教程将详细介绍这两种方法。阅读本文后，您将知道如何添加 Python 注释以及使用哪种样式。

写注释是一种很好的编程习惯。它们是代码中不可执行的部分，但在程序中却非常重要。这些不仅可以帮助从事同一项目的其他程序员，而且测试人员还可以参考它们以明确白盒测试。

最好在创建或更新程序时添加注释，否则可能会丢失上下文。以后写的评论可能没有应有的效果。

一、如何在 Python 中使用单行注释？相关资料领取

当需要简短、快速的注释进行调试时，您可能更喜欢使用单行 Python 注释。单行注释以井号 (#) 开始，并自动以 EOL（行尾）结束。

# 好的代码是自我记录的。

print("Learn Python Step by Step!")
复制代码

# 定义月份列表
months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul','Aug','Sep','Oct','Nov','Dec']

# 打印日历月份的功能
def showCalender(months):
    # For 循环遍历列表并打印每个月的名称
    for month in months:
        print(month)

showCalender(months)
复制代码

复制代码

二、如何在 Python 中使用多行注释？相关资料领取

Python 允许注释跨越多行。此类注释称为多行注释或块注释。您可以使用这种注释方式来描述更复杂的内容。

这种扩展形式的注释适用于后面的部分或全部代码。这是使用多行 Python 注释的示例。

2.1使用哈希标记进行评论

要添加多行注释，每行应以井号 (#) 开始，后跟一个空格。您可以将评论分成段落。只需在每个段落之间添加一个带有井号的空行。

注意：符号 (#) 也称为 octothorpe。该术语来自贝尔实验室的一组工程师，他们在进行第一个按键式键盘项目时。

# 要学习任何语言，您必须遵循以下规则。
# 1. 了解基本语法、数据类型、控制结构和条件语句。
# 2. 学习错误处理和文件 I/O。
# 3. 阅读高级数据结构。
# 4. 编写函数并遵循 OOP 概念。

def main():
    print("Let's start to learn Python.")
...
复制代码

三、如何在 Python 中使用文档字符串？相关资料领取

Python 具有文档字符串（或文档字符串）功能。它为程序员提供了一种简单的方法，可以为每个 Python 模块、函数、类和方法添加快速注释。

您可以通过将其添加为字符串常量来定义文档字符串。它必须是对象（模块、函数、类和方法）定义中的第一条语句。

文档字符串比 Python 注释的范围更广。因此，它应该描述函数做什么，而不是如何。此外，程序的所有功能都具有文档字符串是一种很好的做法。

3.1对文档字符串使用三引号

您可以在三重引号的帮助下定义文档字符串。在字符串的开头添加一个，在字符串的末尾添加第二个。就像多行注释一样，文档字符串也可以重叠到多行。

注意：使用三引号定义的字符串在 Python 中是 docstring。但是，它在您看来可能是常规评论。

3.2Python中的文档字符串与注释什么区别？

以三引号开头的字符串仍然是常规字符串，但它们可以扩展到多行。这意味着它们是可执行的语句。如果它们没有被标记，那么一旦代码执行它们就会被垃圾收集。

Python 解释器不会像处理注释那样忽略它们。但是，如果这样的字符串紧跟在函数或类定义之后或模块之上，则它们会变成文档字符串。您可以使用以下特殊变量访问它们。

myobj.__doc__
复制代码

例子

def theFunction():
    '''
This function demonstrate the use of docstring in Python.
    '''
    print("Python docstrings are not comments.")

print("\\nJust printing the docstring value...")
print(theFunction.__doc__)
复制代码

注释和文档字符串为程序添加值。它们使您的程序更具可读性和可维护性。即使您稍后需要重构相同的代码，使用可用的注释也会更容易。