python - Python 函数中的缩进和注释

Question

我正在使用 Python 2.7 并编写了以下内容:

def arithmetic(A):    x=1"""Some comments here"""      if x=1:        x=1    elif x=2:        x=2    return 0

但它有缩进问题:

    if x=1:    ^IndentationError: unexpected indent

那么函数中怎么写注释呢？

Answer 1

"""xxx """ 是一个 docstring。是的，它可以用作注释，但最终会成为实际代码的一部分，因此需要缩进:

def arithmetic(A):
    x=1
    """
    Some comments here
    """  
    if x==1:
        x=1
    elif x==2:
        x=2
    return 0

如果您使用以 # 开头的面向行的注释，它们不是实际代码的一部分，因此它们的缩进无关紧要。

文档字符串的一个好处是工具可以使用它们，例如，显示有关函数的信息。如果您曾经在 Python 命令提示符下使用过 help(some_function)，您就会看到文档字符串。

事实上，如果您将函数加载到 IDE 中，然后键入 help(arithmetic)，您可以看到 “Some comments here”。

我稍微修改了你的代码，因为在 Python 中，= 用于赋值，你必须在你的 if 语句中使用 == 来检查是否相等。

因此代码将按原样编译和运行，但请注意，只有在 x 已经等于 1 时才将 x 设置为 1 实际上不会做任何事情:)