成为更好的编码员：提示

php中文网 2024-10-15 12:27:41

网上流传着无数的 Python 最佳实践，对每个最佳实践的看法可能会因你询问的人而异。互联网使专业知识民主化，允许任何人——包括我自己——分享他们的观点。然而，在本文中，我们将重点关注 10 个永恒的 Python 最佳实践，这些实践已获得广泛共识并被广泛认为是基础。

Pandas 备忘单

Git 命令备忘单

50 多个 SQL 面试问题

提示 1：函数应指定参数和返回类型
定义函数时，您希望始终指定参数的类型以及函数返回的数据类型。这将帮助您和团队中的开发人员知道会发生什么，而不必总是使用打印语句来获得直观的理解。

提示 2：函数应该处于同一抽象级别
当我们谈论处于同一抽象级别的函数时，我们指的是函数应该执行单个、定义良好的任务的想法。该任务在整个功能中应该处于一致的抽象级别。换句话说，函数应该专注于特定级别的细节或复杂性，并且所有函数的操作都应该在同一级别上进行。

技巧 3：函数应该很小
函数应该是可重用的。而且函数越大，可重用的可能性就越小。这也与为什么一个函数应该只做一件事相关。如果它只做一件事，那么它很可能会很小。

技巧4：开闭原则
开闭原则 (OCP) 规定类、方法或函数必须对扩展开放，但不能对其修改。这意味着定义的任何类、方法或函数都可以轻松地重用或扩展用于多个实例，而无需更改其代码。
这不符合 OCP，因为每当有一个新的国家时，我们就需要编写一个新的 if 语句来补充它。现在这可能看起来很简单，但想象一下我们有 100 个或更多的国家/地区需要考虑。看起来怎么样？

提示 5：不惜一切代价避免发表评论
评论有一种虚假的真实性。它们将读者的注意力从代码实际执行的操作转移到其他人所说的执行的操作上。

随着时间的推移以及代码收到更新或更改，这可能会变得非常成问题。在某些时候，评论会变成谎言，现在每个人都必须通过谎言的镜头来观察真相。

必须不惜一切代价避免发表评论。评论迫使读者继承你的想法，而你的想法充其量只是过去的。当函数或类发生变化时，它的注释很可能不会随之改变。最有可能的是，它们阻碍了读者向前思考。

注释表明作者精神上无法提供描述性良好的类、函数或变量名称。它暴露了程序员平庸的态度，并迫使团队继承这样的态度。

提示 6：避免使用幻数
幻数是一个硬编码值，可能会在稍后阶段发生变化，但因此很难更新。

例如，假设您有一个页面在“您的订单”概览页面中显示最后 50 个订单。 50 是这里的神奇数字，因为它不是通过标准或约定设置的，它是您出于规范中概述的原因而编造的数字。

现在，您要做的就是在不同的地方拥有 50 个订单 - 您的 SQL 脚本（从订单中选择前 50 个 *）、您的网站（您的最后 50 个订单）、您的订单登录信息（for (i = 0; i

提示 7：避免深层嵌套
限制循环、条件或函数内的嵌套级别以提高可读性。

提示 8：避免硬编码路径
避免对文件路径或 URL 进行硬编码；请改用配置文件或环境变量。

提示9：小班授课
是的！班级规模应尽可能小。就像函数一样。

唯一的区别是，在函数中，大小由该函数中的行数决定，而在类中，大小由该类中的职责数量决定。

通常，类名代表它可能拥有的职责类型，但是当名称不明确或过于笼统时，很可能我们赋予了它太多的职责。