如何在 Python 中创建多行注释？

Question

如何进行多行注释？大多数语言都有块注释符号，例如：

 /*

*/

原文由 Dungeon Hunter 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 1

您可以使用三引号字符串。当它们不是文档字符串（类/函数/模块中的第一件事）时，它们将被忽略。

 '''
This is a multiline
comment.
'''

（确保适当缩进前导 ''' 以避免出现 IndentationError 。）

Guido van Rossum （Python 的创建者）在 推特上将此 作为“专业提示”。

然而，Python 的风格指南 PEP8 倾向于使用连续的单行注释，如下所示：

 # This is a multiline
# comment.

…这也是您在许多项目中会发现的。文本编辑器通常有一个快捷方式来轻松完成此操作。

原文由 Petr Viktorin 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 2

Python 确实具有 多行字符串/注释语法，除非用作文档字符串，否则 多行字符串 不会生成字节码——就像 # 前置注释一样。实际上，它的作用与评论完全一样。

另一方面，如果您说这种行为必须记录在官方文档中才能成为真正的注释语法，那么是的，您说得对，不能保证它是语言规范的一部分。

在任何情况下，您的文本编辑器还应该能够轻松地注释掉选定的区域（通过将 # 分别放在每一行的前面）。如果没有，请切换到可以的文本编辑器。

在没有某些文本编辑功能的情况下使用 Python 进行编程可能是一种痛苦的经历。找到合适的编辑器（并知道如何使用它）可以极大地改变人们对 Python 编程体验的看法。

文本编辑器不仅应该能够注释掉选定的区域，还应该能够轻松地左右移动代码块，并且当您按 Enter 时它应该自动将光标置于当前缩进级别。代码折叠也很有用。

---

为了防止链接衰减，以下是 Guido van Rossum 推文 的内容：

@BSUCSClub Python 提示：您可以使用多行字符串作为多行注释。除非用作文档字符串，否则它们不会生成任何代码！ :-)

原文由 unutbu 发布，翻译遵循 CC BY-SA 4.0 许可协议