写出整洁代码

版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文链接： https://blog.csdn.net/weixin_43283397/article/details/101520268

整洁的代码的要求：

• 优雅且高效；直截了当；减少依赖；只做好一件事
• 简单直接
• 可读，可维护，单元测试
• 不要重复、单一职责，表达力（Expressiveness）

一. 命名的艺术

1.1 名副其实

好的变量名告诉你：是什么东西，为什么存在，该怎么使用

栗子：

# bad code
def getItem(theList):
   ret = []
   for x in theList:
      if x[0] == 4:
         ret.append(x)
   return ret

# good code
def getFlaggedCell(gameBoard):
   '''扫雷游戏，flagged： 翻转'''
   flaggedCells = []
   for cell in gameBoard:
      if cell.IsFlagged():
         flaggedCells.append(cell)
   return flaggedCells

1.2 概念的区分度

栗子：

# bad
def copy(a_list, b_list):
    pass

# good
def copy(source, destination):
    pass

注：source：源, destination：目的地

1.3 单词名称可读、方便搜索

注意
比如变量 temp 不直接

二. 注释

1. 以下一些情况属于好的注释

• 对意图的注释，为什么要这么做，函数的输入输出
• 警示
• 放大看似不合理之物的重要性

最坏的注释就是过时或者错误的注释

…

学习链接：
https://blog.csdn.net/jeffli1993/article/details/100883370