Cab*_*oup 3 python arguments function naming-conventions
函数参数的名称是否应该反映使用它们的函数的上下文?举一个Python的具体例子(摘自这本教科书):
def create_radio_button(rb_name, rb_value):
Run Code Online (Sandbox Code Playgroud)
与
def create_radio_button(name, value):
Run Code Online (Sandbox Code Playgroud)
Python风格指南建议使用下划线来避免关键字冲突,但没有提到在参数中使用前缀。在《简洁代码》中,鲍勃·马丁 (Bob Martin) 建议选择可发音的变量名称,并避免编码,这可能会影响rb_前缀。然而,他遵循这一点,指出变量名称应该是可搜索的。我的主要目标是提高代码的清晰度,因此我有兴趣听听人们认为最容易使用的内容。
这取决于上下文,也许在某种程度上取决于个人偏好。
def create_radio_button(name, value)
Run Code Online (Sandbox Code Playgroud)
在这里推荐上面的选项而不是其他选项,因为我可以从上下文中看到我们正在谈论一个单选按钮,因此“rb_”前缀是多余的信息,它已经在函数名称中重复了。
关于变量名称可搜索的评论我猜是指使用变量名称(例如 )的不良做法p,您可能想要搜索或突出显示变量名称,从而导致查找任何包含 的单词的烦恼p。这个问题在这里不太适用,“名称”和“值”足够可搜索*。
* 对于使用像样的编辑器的人来说,最后一点有点没有意义,我们可以在编辑器中重构/重命名符号,并且 IDE 应该足够智能,能够知道用法在上下文/范围中的位置
| 归档时间: |
|
| 查看次数: |
5187 次 |
| 最近记录: |