美文网首页
如何读js函数文档

如何读js函数文档

作者: 我背井离乡了好多年 | 来源:发表于2020-11-24 21:03 被阅读0次

    首先,这样使用中括号只是出于一种的表达形式的需要而已(这样的表达形式很常见),这与api本身是没有关系的。
    然后,我们拿上面的例子来说

    buf.write(string[, offset[, length]][, encoding])
    对于buf.write这个方法:
    第一个参数string是必须的,他表示你要写入的内容;往后的offset、length、encoding这些参数都是非必须的。这些参数你可以不传(用[]括起来表示不传),但并不表示这三个参数你想怎么传就怎么传的,这里是有规则的,规则从这里中括号的对应关系中可以看出来。我们来看他的对应关系:[, offset[, length]] && [ encoding]。这表示offset、length和encoding你可以传或者不传,但是你要是没有传offset的话那length是一定不能传的,这就是为什么length要放在offset的括号里面的原因。
    所以整个例子理解起来就是:
    string必须传,offset、length、encoding可传可不传,但是offset不传的话length也不能传。

    至于这样写有什么好处,我想这可能是当初写api那帮家伙觉得这样表达更合理吧,后面写文档的觉得这种方式还不错,就依葫芦画瓢了,慢慢的就约定俗成了。

    相关文章

      网友评论

          本文标题:如何读js函数文档

          本文链接:https://www.haomeiwen.com/subject/ahbjbktx.html