提高Python代码可读性的五个基本技巧

译者 | 赵青窕

审校 | 孙淑娟

你是否经常回头看看6个月前写的代码，想知道这段代码底是怎么回事?或者从别人手上接手项目，并且不知道从哪里开始?这样的情况对开发者来说是比较常见的。Python中有许多方法可以帮助我们理解代码的内部工作方式，因此当您从头来看代码或者写代码时，应该会更容易地从停止的地方继续下去。

在此我给大家举个例子，我们可能会得到如下图所示的代码。这还不是最糟糕的，但有一些事情需要我们去确认，例如:

在本文中，我将介绍如何通过文档、提示输入和适当的变量名称来提高应用/脚本的可读性的5个基本技巧。

1.注释 

我们可以对代码做的第一件事是向某些行添加注释，但是要注意避免注释得过多。注释中需要阐述代码为什么能起作用，或者为什么某些事情要以某种方式完成，而不是它是如何实现的。Python中的注释通常使用井号(#)来完成，可以跨一行也可以跨多行。

# Comment using the hashtag# Another comment using the hashtag

对于多行注释，我们也可以使用双引号。

"""This is an example ofa multi-line comment"""

在下面的示例中，代码中添加了一些注释，以解释某些代码行的工作流程和原因：

2.显式类型 

Python语言是动态类型的，这意味着变量类型只会在运行时被检查。此外，变量可以在代码执行期间更改类型。另一方面，静态类型涉及显式地声明变量类型，并且在代码执行期间不能更改。

2014年，PEP 484引入了类型提示的概念，随后这个概念引入到了Python 3.5版本中。这允许您显式地声明变量类型。通过添加类型提示，可以显著提高代码的可读性。在下面的例子中，我们可以看出:

根据类型提示，我们可以确切地知道函数需要什么，以及它将返回什么。

3.文档字符串 

文档字符串是紧跟在函数或类定义之后的字符串。文档字符串是一种很好的方式，可以详细解释函数的功能、需要什么参数、将引发的异常、返回值等等。此外，如果使用Sphinx之类的工具为代码创建在线文档，文档字符串将自动提取并转换为适当的文档。下面的示例显示了名为clay_volume的函数对应的文档字符串。这里我们可以指明每个参数的含义。这使它比基本的类型提示更详细。您还可以包含