如何通过5个技巧有效提升Python代码的可读性？

本文共计1938个文字，预计阅读时间需要8分钟。

目录

1.注释

2.明确类型

3.文档字符串（Docstrings）

4.可读变量名

5.避免魔法数字

总结不知小伴侣们是否有过这样的困惑，当我们回顾自己几个月前编写的代码时，会发现代码之谜。

目录

• 1. Comments
• 2. Explicit Typing
• 3. Docstrings (Documentation Strings)
• 4. Readable Variable Names
• 5. Avoiding Magic Numbers
• 总结

不知道小伙伴们是否有这样的困惑，当我们回顾自己 6 个月前编写的一些代码时，往往会看的一头雾水，或者是否当我们接手其他人的代码时，

Python 中有许多方法可以帮助我们理解代码的内部工作原理，良好的编程习惯，可以使我们的工作事半功倍！

例如，我们最终可能会得到看起来很像下图中的代码。虽然不是最糟糕的，但是，我们需要扩展一些事情，例如：

• load_las_file 函数中的 f 和 d 代表什么？
• 为什么我们要在 clay 函数中检查结果？
• 这些函数需要什么类型？ Floats? DataFrames?

在本文中，我们将着重讨论如何通过文档、提示输入和正确的变量名称来提高应用程序/脚本的可读性的五个基本技巧。

1. Comments

我们可以对我们的代码做的第一件事是为我们的代码添加某些注释，但是却不能过度使用它。