写代码注释是一件很重要的事情,如果你写的一段函数给别人调用那么往往都需要配上一些基本的注释。写好代码可以让别人容易阅读你
的代码。试想一 下:如果你在github上面找到一段你想要的代码,这段代码有200行,可能这些代码我们要进行改造,那么这时候如果代
码中都没有恰当的注释,我们可能要用比较久的时间去通读一下他的代码。
相反,如果这些代码有一些恰当的注释,我们可能会更加好理解一点。学会注释是编码过程中不可或缺的一部分。那么什么样的注释才是
规范的注释,才能让其他看你代码的人能快速的了解你得代码结构呢。我们今天就说一说 有关于Python的一些注释规范。
在说规范之前我们有必要先看以下Python的注释有哪些?
单行注释 多行注释 特殊注释
单行注释一般写在语句的后面,如
name = 'Lily' #变量
多行注释,以三个引号开始,三个引号结尾。这三个引号可以使单引号也可以是双引号。
""" 这里写的是多行注释, 这里写的是多行注释, 这里写的是多行注释, """