用Python阻止注释

评论

注释是计算机程序中的一段文本，旨在作为源代码中的程序员可读的解释或注释，并且被编译器/解释器忽略。

简而言之，随着我们开始向程序中添加更多功能和特性，代码的大小也随之增加！可能会发生，几个月后返回时，我们可能无法理解它并感到困惑！

因此，在程序中添加注释是最重要的卫生因素之一。确保您的代码可以被他人和您轻松理解（即使几个月后重新访问）也很重要。文本编辑器通常以不同的方式突出显示注释，因此可以轻松识别它们。

通常，代码仅告诉您它是如何执行的，而不能告诉您为什么这样做？

有时我们的变量也没有被特别命名。但是，python中的注释可以帮助我们获得更好的清晰度。我们使用注释来解释特定步骤/算法背后的公式和实际逻辑。

Python注释类型

Python可以同时具有块注释和内联注释，

1）块注释

块注释适用于其后的代码段。它可能适用于部分代码或整个代码。它们缩进到与该代码相同的级别。每行注释都以＃开头。

# Python程序打印
# 你好，世界

print("Hello World")

输出：

Hello World

块注释也可以使用''''''进行。这些引号之间写的任何内容均视为注释。

'''
Python program to print
Hello World
'''

print("Hello World")

输出：

Hello World

除非在定义函数，方法，类或模块之后立即使用它。在这种情况下，它成为docstring。

def hello():
    '''
    Here, this is docstring 
    since it is written right after 
    the function definition.

    below given print statement will print 
    Hello World
    '''
    print("Hello World")

if __name__ == "__main__":
  # 调用hello函数
  hello()

输出：

Hello World

2）内联评论

一个行内注释是在同一行作为语句的注释。内联注释应与该语句至少分隔两个空格。它们应以＃和单个空格开头。

print("Hello World")  # 这是内联评论

输出：

Hello World