JavaScript API函数名称最佳实践

时间:2014-11-13 00:22:39

标签: javascript oop object setter

哪一种是增加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;
}   

1 个答案:

答案 0 :(得分:2)

没有"首选"增加一个我所知道的值的方法,但是一个好的经验法则是

  1. 与函数名中函数的意图一样真实 可能的。

  2. 编写只做一件事的功能

  3. 例如这个函数:

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

    分为两个单独的函数setX(val)increaseXByVal(val)

    ,可以更好地完成两项不同的操作

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

    addX的问题在于它暗示您将x添加到提供的数字然后返回该值。相反,你正在做的事情addingValueToX确实没有混淆