用自己的语言对程序的某些代码进行标注和说明,增加程序的可读性。
单行注释(行注释)示例如下:
以#
开头,#
右边写上代码说明的文字
# 这是一个单行注释 输出hello python
print("hello python")
# 后面建议 先添加一个空格 然后再写说明文字,这样代码格式更美观
直接在代码右边添加注释的时候 为保证代码的可读性,注释和代码之间至少要有2个空格
print("hello python") # 输出hello python
描述信息非常多的时候,一行无法显示。
多行注释(块注释)示例:
"""
注释内容多行
注释内容继续 中间可以写很多内容
注释内容很多
"""
一对 连续的 三个引号 (单引号,双引号 都可以)
注释不是越多越好,一目了然的代码不需要注释
复杂的操作,要在操作前写上注释;不是一目了然的代码,在其行尾 注释。
一定编写符合规范的代码,才能快速融入开发团队。
Python语言规范中文版
https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/