【Python基础】lpthw - Exercise 45 制做游戏

  做者在本节中给出了 一些风格建议。函数

  1、函数的风格文档

  1. 类里面的函数常常被称做“方法”,但实质上它和函数没什么不一样。it

  2. 使用类的时候,能够用动词而不是名词给函数命名,指明其具体功能,例如list和pop。变量

  3. 让函数保持简单小巧。awesome

 

  2、 类的风格方法

  1. 类名使用驼峰式大小写。命名

  2. __init__中不要作太多事情,不然会让类变得难用。注释

  3. 类中的其余函数应该使用下划线分割词,如my_awesome_hair。代码风格

  4. 用一致的方式组织函数的参数,保持其参数顺序的一致性。例如若是一个类要处理users、dogs、cats,就保持这个次序。若是一个函数的参数是(dog,cat,user),另外一个倒是(user,dog,cat),会让函数使用起来比较困难。字符

  5. 类中最好不要使用来自模块的变量或者全局变量。

  6. 灵活对待所谓的“风格一致性”。

 

  3、代码风格

  1. 为代码字符之间留空白,加强可读性。

  2. 学会模仿喜欢的风格。

 

  4、好的注释

  1. 在注释中指出“为何要这么作”。

  2. 为函数写文档注释。

  3. 注意维护。若是代码作了修改,注释也要更新。