Python 注释

Python 注释对于程序员来说是一个必不可少的工具。注释通常用于解释代码。如果代码有适当的解释，我们很容易理解。一个好的程序员必须使用注释，因为将来任何人都想修改代码以及实现新的模块；然后，它可以很容易地完成。

在其他编程语言(如 C++)中，它为单行注释和/提供了//选项…/表示多行注释，但 Python 提供单行 Python 注释。为了在代码中应用注释，我们在语句或代码的开头使用哈希(#)。

让我们理解下面的例子。

# This is the print statement
print("Hello Python")

这里，我们使用哈希(#)对 print 语句进行了注释。不会影响我们的打印声明。

Python 多行 Comment

我们必须在每一行代码的开头使用哈希(#)来应用多行 Python 注释。考虑下面的例子。

# First line of the comment 
# Second line of the comment
# Third line of the comment

示例:

# Variable a holds value 5
# Variable b holds value 10
# Variable c holds sum of a and b
# Print the result
a = 5
b = 10
c = a+b
print("The sum is:", c)

输出:

The sum is: 15

上面的代码非常易读，即使是绝对的初学者也能理解每一行代码中发生的事情。这就是在代码中使用注释的好处。

对于多行注释，我们也可以使用三重引号(’ ’ ’ ')。三重引号也用于字符串格式。考虑下面的例子。

文档字符串 Python 注释

docstring 注释主要用于模块、函数、类或方法。它是一个 Python 文档字符串。我们将在后续教程中解释该类/方法。

示例:

def intro():
  """
  This function prints Hello Joseph
  """
  print("Hi Joseph")            
intro()

输出:

Hello Joseph

我们可以通过使用 doc 属性来检查函数的文档字符串。

def intro():
  """
  This function prints Hello Joseph
  """
  print("Hello Joseph")            
intro.__doc__

输出:

Output:
'\n  This function prints Hello Joseph\n  '

注意:docstring 必须是函数中的第一件事；否则，Python 解释器无法获取 docstring。

Python 缩进

Python 使用缩进来定义代码块。其他编程语言如 C、C++和 Java 使用花括号{}，而 Python 使用缩进。空白在 Python 中用作缩进。

缩进在代码的开头使用，并以非预期的一行结束。同一行缩进定义了代码块(函数体、循环等)。)

通常，四个空格用作缩进。缩进量取决于用户，但必须在整个块中保持一致。

for i in range(5):
    print(i)
    if(i == 3):
        break

为了表示一个代码块，我们用相同的空格缩进代码块的每一行。

考虑下面的例子。

dn = int(input("Enter the number:"))
if(n%2 == 0):
    print("Even Number")
else:
    print("Odd Number")

print("Task Complete")

输出:

Enter the number: 10
Even Number
Task Complete

上面的代码， if 和 else 是两个独立的代码块。两个代码块都缩进四个空格。print(“任务完成”)语句没有缩进四个空格，并且超出了 if-else 块。

如果缩进使用不当，将导致缩进错误。

原文：https://www.javatpoint.com/python-comments

---