成为更好的编码员:提示
2024-09-29 20:13:26
网上流传着无数 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:小班授课 是的!班级规模应尽可能小。就像函数一样。
唯一的区别是,在函数中,大小取决于函数中的行数,而在类中,大小取决于该类中的责任数。
一般来说,类名代表着它可能拥有的责任类型,但当名称不清楚或过于笼统时,我们很可能会给它太多的责任。
这让我们回来了 SRP(单一责任原则),它规定一个类应该只有一个理由——一个责任——改变。
提示 10:避免复杂的三元表达式 避免使用过于复杂的三元表达式;优先考虑可读性而不是简洁性,使代码更容易理解。
以上是成为更好的编码员:详细提示,请关注图灵教育的其他相关文章!