作者在本节中给出了 一些风格建议。
一、函数的风格
1. 类里面的函数经常被称作“方法”,但实质上它和函数没什么不同。
2. 使用类的时候,可以用动词而不是名词给函数命名,指明其具体功能,例如list和pop。
3. 让函数保持简单小巧。
二、 类的风格
1. 类名使用驼峰式大小写。
2. __init__中不要做太多事情,否则会让类变得难用。
3. 类中的其他函数应该使用下划线分割词,如my_awesome_hair。
4. 用一致的方式组织函数的参数,保持其参数顺序的一致性。例如如果一个类要处理users、dogs、cats,就保持这个次序。如果一个函数的参数是(dog,cat,user),另一个却是(user,dog,cat),会让函数使用起来比较困难。
5. 类中最好不要使用来自模块的变量或者全局变量。
6. 灵活对待所谓的“风格一致性”。
三、代码风格
1. 为代码字符之间留空白,增强可读性。
2. 学会模仿喜欢的风格。
四、好的注释
1. 在注释中指出“为什么要这么做”。
2. 为函数写文档注释。
3. 注意维护。如果代码做了修改,注释也要更新。