JavaScript API 函数名称最佳实践 [关闭]答案

【问题标题】：JavaScript API Function Name Best Practices [closed]JavaScript API 函数名称最佳实践 [关闭]
【发布时间】：2014-11-13 00:22:38
【问题描述】：

哪一种是增加 API 值的首选方式。

.setX(val,increase){
    if(increase) this.x += val;
    else this.x = val;
}
.increaseX(val){
    this.x += val;
}   
.incrementX(val){
    this.x += val;
}   
.addX(val){
    this.x += val;
}

【问题讨论】：

肯定会选择add(val)...
increment 通常表示“增加一”（或至少增加一个固定的“步数”），因此它不会将数量作为参数。

标签： javascript oop object setter

【解决方案1】：

据我所知，没有一种“首选”方式来增加价值，但一个好的经验法则是

在函数名称中与函数的意图一样真实可能。
编写只做一件事的函数

例如这个函数：

.setX(val,increase){
    if(increase) this.x += val;
    else this.x = val;
}

执行两个单独的操作，最好拆分成两个单独的函数setX(val) 和increaseXByVal(val)

在您提供的名称中，increaseX 似乎最接近函数的真正意图，但不清楚您将其增加什么或它需要一个参数。这可以通过使用我提供的名称来解决，但这确实是一个偏好问题。

addX 的问题在于它意味着您将 x 加到提供的数字上，然后返回该值。相反，您正在做的是真正的addingValueToX，这不会造成混淆

【讨论】：