让更多的人读懂你的代码--注释

学习任何一门编程语言的开始都需要学习它的注释怎么写，注释可以帮助我们理解代码的意图。

注释是啥？

计算机编程的本质就是传递信息，好的代码不仅能够把程序员的指令传递给计算机，还能够把程序员的意图传递给其他阅读代码的人。

注释的存在正是为了帮助人们理解代码的意图，它不会对程序的行为产生任何影响。

python的两种注释

单行注释

在python中单行注释使用#,#后直到行尾的内容会被忽略，不会被python解释器执行。

多行注释

在python中多行注释使用一对三引号''' '''/""" """（英文状态下），三引号之间的所有内容都会被忽略，不会被python解释器执行。

如何用好注释呢？

一个好的开发者的标志之一就是他的注释：在该注释的地方注释，在不需要注释的地方则不注释，甚至写得好的自描述函数本身就是一种注释。

好的注释可以使我们更好地维护代码，一段时间之后依然可以更高效地回到代码高效开发。

注释这些内容：

• 整体架构，高层次的观点。
• 函数的用法。
• 重要的解决方案，特别是在不是很明显时。

避免注释：

• 描述“代码如何工作”和“代码做了什么”。
• 避免在代码已经足够简单或代码有很好的自描述性而不需要注释的情况下，还写些没必要的注释。

文末

以上就是注释的一些基本知识，如果你觉得我写的不错，就请给个赞赏吧，欢迎扫一扫下方二维码关注我的微信公众号，获取更多python知识哦~

更多精彩python教程请来B站关注我哦：https://www.bilibili.com/video/BV1K84y1c7v4