对代码进行注释

Python 支持使用井号（或哈希）且后面带有注释文本的注释：

# I am a comment...

注释始终延伸到行尾，并且始终只有一行。 对于多行注释，需将井号放在每行开头。 注释可能出现在一行的开头或在空格或代码后面，但不会出现字符串中 - 在这种情况下，它只是文本中的井号符号。

# I am a comment...
x = 1   # the rest of the line is a comment
        # ... and this is a 3rd comment
text = "# But this isn't a comment because it's a string literal and in quotes."
# This is a comment
# that crosses multiple lines

一些程序员避免使用有利于编写“自编文档代码”的注释，因为描述性变量和函数名易于理解。 自编文档代码没有任何问题，但是请务必使用注释来尽可能清楚地表达你的想法和意向。 如果你在 10 分钟前编写了代码块，你可能非常清楚其目的。 但是从现在起一年内，位置得当的注释可能对于你和其他第一次看到代码的程序员一样有帮助。