你的代码的风格
参考网址:http://www.jb51.net/shouce/Pythonbbf/latest/ex44.html
类的风格:
class应该使用“camel case”(驼峰式大小写) 例如不是super_gold_factory应该是 SuperGoldFactory
__init__不应该做太多的事情,这会让你的class变得难以使用
clas要使用class Name(object)的方式定义类
不要对全局变量或是来自模组的变量进行定义,让这些东西自顾自就行
用一致的方式组织函数,如果你的class需要处理dogs,cats,foxes,保持这个顺序(特别情况除外),如果
一个函数的参数是(dog,cat,fox),另一个是(cat,dog,fox),这样函数使用起来困难
函数风格:
函数应该使用“underscore format”(下划线隔词) ,例如myawersomehair应该写成my_awesome_hair
不管是类中的函数还是单独的函数,都应该让你的函数保持简单小巧
class中的函数也叫方法。在使用class时,大部分时间是告诉你的class如何做事情,所以给函数的命名与其命名成一个名词,
不如命名成一个动词,作为给class的命令,比如pop和remove_from_end_of_list,两者功能虽然一样,但是后者不是一个命令。
代码风格
为了方便阅读,在代码字符之间留一些空白,这时一个好习惯
模仿你喜欢的代码的风格
好的注释
写好的注释,描述清除为什么你要这样做。代码只会告诉你“这样实现”,不会告诉你“为什么要这样实现”,而后者比前者更重要
注释要短小精悍,注释也是需要维护的
代码如果做了更新,记得检查并更新相关注释
posted on 2016-12-16 10:59 zhuzhu2016 阅读(323) 评论(0) 编辑 收藏 举报