Python函数中的缩进和注释

Python函数中的缩进和注释,python,Python,我正在使用Python 2.7,并编写了以下内容: def arithmetic(A): x=1 """ Some comments here """ if x=1: x=1 elif x=2: x=2 return 0 定义算术(A): x=1 """ 这里有一些评论 """ 如果x=1: x=1 elif x=2: x=2 返回0 但它有一个问题: if x=1: ^ IndentationError: unex

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

def arithmetic(A): x=1 """ Some comments here """ if x=1: x=1 elif x=2: x=2 return 0 定义算术(A): x=1 """ 这里有一些评论 """ 如果x=1: x=1 elif x=2: x=2 返回0 但它有一个问题:

if x=1: ^ IndentationError: unexpected indent 如果x=1: ^ 缩进错误:意外缩进 那么,如何在函数中编写注释呢

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

def arithmetic(A):
    x=1
    """
    Some comments here
    """  
    if x==1:
        x=1
    elif x==2:
        x=2
    return 0
如果使用以
#
开头的面向行的注释,这些注释不是实际代码的一部分,因此它们的缩进并不重要

docstring的一个优点是工具可以使用它们,例如,显示有关函数的信息。如果您曾经在Python命令提示符下使用过
help(some_函数)
,您会看到一个docstring

事实上,如果您将函数加载到IDE中,然后键入
help(算术)
,您可以看到
“此处的一些注释”

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


因此,代码将按原样编译和运行,但请注意,如果x已经等于1,则仅将x设置为1实际上不会起任何作用:)

在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
青年团

python中的注释使用哈希符号或# 对于单行注释和多行注释的三重引号 关于多行注释的一点是,它们有时很挑剔,必须严格遵守 缩进,否则会出现此错误


还请注意,许多python风格的指南和项目通常使用#作为注释。许多文本编辑器和IDE为注释文本块提供了快捷方式,但事实并非如此。注释实际上不需要与函数具有相同的缩进(尽管我认为这样可以更容易地知道注释是函数的一部分),文档字符串(第一行中的“”)确实需要对齐