在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将不会实际执行任何操作：）

Answer 2

CYC，

python中的注释使用哈希符号＃ 用于多行注释的单行注释和三重引号 关于多行评论的事情是，它们有时是挑剔的，必须是 缩进或者你可以得到这个错误

请参阅Way to create multiline comments in Python?

请注意许多python样式指南和项目通常使用＃作为评论。许多文本编辑器和IDE提供了用于注释文本块的快捷方式

Answer 3

在Python中，注释需要与其他代码块具有相同的对齐方式，例如

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

通常人们使用#进行内联评论，例如：

def func(a):
    a = 5
    # I am a comment
    c = 6