当前位置:编程学堂 > 3.python-注释

3.python-注释

  • 发布:2023-10-09 19:01

注释

目标

  • 评论的作用

  • 单行注释(行注释)

  • 多行注释(块注释)

01。评论的作用

使用自己熟悉的语言对程序中的某些代码进行注释,以增强程序的可读性

02。单行注释(行注释)

  • # 开头,# 右边的所有内容都被视为说明文字,而不是实际要执行的程序,仅作为辅助说明

  • 示例代码如下:

#这是第一个单行评论
print("你好Python")

为了保证代码的可读性,#建议先加一个空格,然后再写相应的说明文字

在代码后添加单行注释

  • 也可以在程序开发过程中使用 # 在代码后面(旁边)添加说明文字

  • 示例代码如下:

print("hello python") # 输出 `hello python`

03。多行注释(块注释)

  • 如果您想编写注释,其中包含大量无法在一行中显示的信息,您可以使用多行注释

  • 要在Python程序中使用多行注释,可以使用 一对连续的三个引号(单引号和双引号都可以)

  • 示例代码如下:

"""
这是多行注释
​
多行注释之间,可以写出很多内容……
”“”
print("你好Python")

什么时候需要使用注释?

  1. 注释越多越好,一目了然的代码不需要添加注释

  2. 对于复杂的操作,您应该在开始操作之前写几行注释

  3. 对于不言自明的代码,应在其行尾添加注释(注释应与代码至少间隔2个空格,以提高可读性)

  4. 永远不要描述代码,假设阅读代码的人比你更了解 Python,他只是不知道你的代码是做什么的

在一些正式的开发团队中,通常会有code review的做法,就是团队互相阅读对方的代码

关于代码规格

  • Python 官方提供一系列PEP(Python增强提案)文档

  • 第8篇文档专门针对Python的代码格式,也俗称PEP 8

  • 文档地址:https://www.sychzs.cn/dev/peps/pep-0008/

  • Google有对应的中文文档:http://www.sychzs.cn/en/latest/google-python-styleguide/python_style_rules/

对于任何语言的程序员来说,编写符合规范的代码是开启编程生涯的第一步

相关文章

最新资讯