• 使用常亮来代表代码中的各种状态

  • 例如如下代码 B代码要更具有可读性

  • A

  • if task_obj.task_template.type == 1:     do_something()

  • B

    if task_obj.task_template.type == NORMAL_MODEL:    do_something()

  ​

• 一个函数只做一件事情，一个函数集成太多功能会带来以下问题

  • 可读性变差，不好理解函数到底是做什么的，因为这往往集聚了太多的功能。如果一个函数是一由很多小的单元租出的，你往往能够通过这些小单元的名字来推测出来这个函数的功能。这也再次说明了，函数命名和变量的命名的非常重要
  • 可维护性变差，带代码出现bug的时候非常难以定位问题，你很难在一大串代码中定位是哪个代码出了问题。

• 一个函数下，应该包含同一层抽象的函数。

• 注释尽量不需要，与其想注释，不如思考如何让变量名字更加通俗易懂

• 变量名字：

  • 一个相关系统的变量应该足够的相关，例如

    • food_category
    • food_menu
    • food_library

  • 同一个概念不要使用难以区分的近义词

    • 例如 food_ticket, meal_ticket 类似看不出区别的变量

    ​

    ​

    ​