编程规范的重要性
注释:
注释不止是为了自己以后看的更清楚,还是为了以后的开发人员所准备的,其实一段时间后,当需要对程序做一些修改或者是改正某个bug的时候,可能未来的我们自己都会忘记相关的细节,所以此时注释显得尤为重要。
每条注释以井号(#)开始,一直到该行末尾结束,一直到该行末尾结束。我们可以在注释中放任何东西,因为Python 会完全无视他们的存在。为了写好注释,这里给出以后几条规则:
(1) 假设读者的Python 水平和你一样(比如说,不要去解释 “ 什么是字符串 ” , 也不要去解释 “ 什么是赋值语句 ”)
(2) 不要去注释那些毫无意义的事情。比如说:
count = count +1 # add one to count
(3) 很多程序员会在代码上写上一些以 “ TODO ” 或者 “ FIXME ”开始的注释,目的就是为了提醒他们回来编写或清理一些未完成的一些问题。
(4) 如果你在编写某段程序的时候需要使劲思考的话,应该编写注释,以后别人不会在这个地方绞尽脑汁。尤其要注意的是,如果你在