1.4　总结

在一段代码里，变量和注释是最接近自然语言的东西。因此，好的变量名、简明扼要的注释，都可以显著提升代码的质量。在给变量起名时，请尽量使用描述性强的名字，但也得注意别过了头。

从小R的面试故事来看，即使是两段功能完全一样的代码，也会因为变量和注释的区别，给其他人截然不同的感觉。因此，要想让你的代码给人留下“漂亮”的第一印象，请记得在变量和注释上多下功夫。

以下是本章要点知识总结。

(1) 变量和注释决定“第一印象”

·变量和注释是代码里最接近自然语言的东西，它们的可读性非常重要

·即使是实现同一个算法，变量和注释不一样，给人的感觉也会截然不同

(2) 基础知识

·Python的变量赋值语法非常灵活，可以使用*variables星号表达式灵活赋值

·编写注释的两个要点：不要用来屏蔽代码，而是用来解释“为什么”

·接口注释是为使用者而写，因此应该简明扼要地描述函数职责，而不必包含太多内部细节

·可以用Sphinx格式文档或类型注解给变量标明类型

(3) 变量名字很重要

·给变量起名要遵循PEP 8原则，代码的其他部分也同样如此

·尽量给变量起描述性强的名字，但评价描述性也需要结合场景

·在保证描述性的前提下，变量名要尽量短

·变量名要匹配它所表达的类型

·可以使用一两个字母的超短名字，但注意不要过度使用

(4) 代码组织技巧

·按照代码的职责来组织代码：让变量定义靠近使用

·适当定义临时变量可以提升代码的可读性

·不必要的变量会让代码显得冗长、啰唆

·同一个作用域内不要有太多变量，解决办法：提炼数据类、拆分函数

·空行也是一种特殊的“注释”，适当的空行可以让代码更易读

(5) 代码可维护性技巧

·保持变量在两个方面的一致性：名字一致性与类型一致性

·显式优于隐式：不要使用locals() 批量获取变量

·把接口注释当成一种函数设计工具：先写注释，后写代码