python的多行注释以三个单引号开头和结尾_Python入门系列10-Python的注释

在任何的编程语言中，注释都不是被用来给电脑执行的，但是注释在编写代码的过程中是非常有必要的。虽然我们可以在代码中不写任何注释，但是我不推荐这么做，因为注释在我们日后回来阅读之前写的代码将起很大的作用。

注释可以让我们阅读自己的或者别人的代码的时候，不至于一头雾水。毕竟当时灵光一现的点子在现在未必能理解，人都是擅长遗忘的。

在Python中，对注释的支持也很大，我们不仅仅可以在源代码中阅读注释，还可以在终端中打印出来。

Python支持两种注释风格，分别为单行注释和多行注释。

---

单行注释

单行注释以井号“#”开头，Python的解释器在遇到以#开头的语句的时候，会选择忽略改行的内容。

可以看到，在终端中以#开头的语句部分不会被执行，没有任何的输出。

多行注释

多行注释在Python中使用的频率会更高，因为我们的注释往往很多，多行写注释会让阅读者更舒适。

多行注释用三个单引号 ''' 或者三个双引号 """ 括起来，效果都一样。

上面演示了两种不同的多行注释风格，得到的结果都一样，就是三个单引号或者三个双引号中的内容不会被输出。

---

其实上面的注释只是演示如何在Python中写注释而已，我们一般都是在函数、类、模块中写注释。

最终的目的都是为了说明它们的功能，以便我们容易的理解它们的用法等。

在函数中写注释并且查看注释

可以看到，函数的注释写在函数的内部，它是属于函数的。并且我们可以通过利用“函数名.__doc__”的形式来打印输出函数注释。