01. 注释的作用

在大多数编程语言中,注释都是一项很有用的功能。在一些简单的程序中只包含Python代码,但随着程序越来越大、越来越复杂,就应在其中添加说明,对你解决问题的方法进行大致的阐述。注释让你能够使用熟悉的自然语言在程序中添加说明,增强程序的可读性。

以下截图是一份python游戏的代码,仔细观察没有一个中文字,如果这份代码相当复杂,阅读就会变得很困难。
Python代码注释的用法和意义 Python 第1张

SRE实战 互联网时代守护先锋,助力企业售后服务体系运筹帷幄!一键直达领取阿里云限量特价优惠。

在开发项目期间,你对各个部分如何协同工作了如指掌,但过段时间后,有些细节你可能不记得了。当然,你总是可以通过研究代码来确定各个部分的工作原理,但通过编写注释,以清晰的自然语言对解决方案进行概述,可节省很多时间。

02. 单行注释(行注释)

# 开头,# 后面的内容都会被Python解释器忽略,全部被当做说明文字,而不是真正要执行的程序,只起到辅助说明作用。

# 这是第一个单行注释
print("hello python")
  • 为了保证代码的可读性,# 后面建议先添加一个空格,然后再编写相应的说明文字。
  • 一般都是在代码的上方写注释。
  • 如果代码和注释都很短的情况下,同样可以使用#在代码的后面(旁边)增加说明性的文字。需要注意的是,为了保证代码的可读性注释和代码之间 至少要有 两个空格
  • 示例代码如下:
print("hello python")  # 输出 `hello python`

03. 多行注释(块注释)

如果希望编写的 注释信息很多,一行无法显示,就可以使用多行注释。

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

示例代码如下:

"""
这是一个多行注释

在多行注释之间,可以写很多很多的内容……
""" 
print("hello python")

什么时候需要使用注释?

  1. 注释不是越多越好,对于一目了然的代码,不需要添加注释。
  2. 对于复杂的操作,应该在操作开始前写上若干行注释。
  3. 对于不是一目了然的代码,应在其行尾添加注释(为了提高可读性,注释应该至少离开代码 2 个空格)。
  4. 绝不要描述代码,假设阅读代码的人比你更懂Python,他只是不知道你的代码要做什么。编写注释的主要目的是阐述代码要做什么,以及是如何做的。

要成为专业程序员或与其他程序员合作,就必须编写有意义的注释。当前,大多数软件都是合作编写的,编写者可能是同一家公司的多名员工,也可能是众多致力于同一个开源项目的人员。训练有素的程序员都希望代码中包含注释,因此你最好从现在开始就在程序中添加描述性注释。作为新手,最值得养成的习惯之一是,在代码中编写清晰、简洁的注释。

如果不确定是否要编写注释,就问问自己,找到合理的解决方案前,是否考虑了多个解决方案。如果答案是肯定的,就编写注释对你的解决方案进行说明吧。相比回过头去再添加注释,删除多余的注释要容易得多。

关于代码规范

虽然还没有开始写代码,但是可以收藏起来,时不时看一下,养成规范的代码格式,越早越好。

任何语言的程序员,编写出符合规范的代码,是开始程序生涯的第一步

Python代码注释的用法和意义 Python 第2张

扫码关注我们
微信号:SRE实战
拒绝背锅 运筹帷幄