在前面的代码中我已经在运用注释了,那么注释是什么呢?
注释是一种对代码的解释,能够帮助程序员能好的理解代码,同时不会影响程序的运行。
在初期的代码量极少的情况下,注释的作用可能可有可无,但是一旦开始写一些复杂的程序时,注释的作用就非常的大了,如果某段代码你长时间没有接触后在次接触时,注释会为你节约大量的理解时间,对于他人同样如此。
4.1 注释语法
4.1.1 注释行
使用#
开始的行都是注释。
#注释
4.1.2 文档字符串
使用三引号引起来的称为文档字符串
,也可以将其视为一种注释。
- 可以包括多行内容。
- 一般放在文件/函数/类的开始。
-
'''
或者"""
都可。
'''
文档字符串
文档字符串
文档字符串
'''
4.1.3 注释的规范
- 内容准确:注释内容要和代码一致,匹配,并在代码修改时及时更新。
- 篇幅合理:注释不应该太精简,同时也不能篇幅太长。