听说这是程序员最讨厌做的事情!

#写这段代码的时候,只有上帝和我知道它是干嘛的

#现在,只有上帝知道!

这应该是对所有不写注释的程序员一个最准确的状态描述了。相信所有程序员都对自己有这样一个自信:我自己写的代码我自己一定可以理解的,但过了两个星期甚至更久之后,你还确定你能有这份自信吗?

我们为什么要写注释?

之前听过一句很有意思的话:“程序员最讨厌的四件事:写注释、写文档、别人不写注释、别人不写文档”,确实,在写程序的时候,不写注释是一个很糟糕的习惯。相比回过头去再添加注释,删除多余的注释要容易得多。所以,写注释真的是一个非常重要的习惯。

首先,观点清晰简洁的注释很有必要。良好的代码习惯,能带来事半功倍的效果。不管是作为范例给别人参考,还是多年后自己翻出当年的代码,良好的注释都能一目了然。

其次,注释的目的在于提高代码的后期维护性,也就是说花费了当前的工作时间换取以后节约更多的时间。

最后,在实际中,代码都不是几句话就能解决的,代码越复杂越不容易维护,维护的人也是参差不齐,这更需要我们认真地写注释。

Python的注释

接下来小U主要和大家简单介绍一下如何在Python中添加注释?Python中有两种形式的代码注释:单行注释和多行注释。

单行注释:每条注释以#号开始。#号后面的内容会被Python解释器忽略。这种注释一般使用在那些复杂的算法或者操作的地方,这样的注释可以让别人或者自己在一段时间之后重新阅读这段代码的时候一目了然。

比如:

#向大家介绍自己

print(“hello I'm 优就业Python工程师”)

执行结果:

优就业Python工程师

多行注释:又称文档注释,它使用的是三引号""" """。这种注释主要是为希望使用该程序的人准备的,它描述的是该程序或者函数“能做什么”而不是“怎么做”。这种注释要清楚地描述方法的功能,并对参数、以及可能出现的问题进行必要的说明。

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20181031G1MRBF00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 yunjia_community@tencent.com 删除。

扫码关注云+社区

领取腾讯云代金券