在阅读方法的文档时,参数的括号是什么意思?

时间:2014-02-09 01:46:51

标签: javascript api

通常在阅读有关哪些参数可以传递给方法的文档时,我会看到参数列表中使用的括号如下:

example of brackets used within arguments on method documentation

括号在这种情况下意味着什么?为什么逗号括号内?

3 个答案:

答案 0 :(得分:21)

required [optional] <required> [<optional>, <but both needed>]

几乎总是如此。

答案 1 :(得分:3)

参数周围的括号表示它是可选的。

如果单独编写,则表示您可以使用任何组合中的任何参数。该方法根据值的数据类型确定您使用的内容。所有这些组合都可用于该方法:

.animate(properties, duration, easing, complete)
.animate(properties, duration, easing)
.animate(properties, duration, complete)
.animate(properties, duration)
.animate(properties, easing, complete)
.animate(properties, easing)
.animate(properties, complete)
.animate(properties)

您可以通过其他方式查看括号,而不是围绕每个参数。例如:

.method(p1 [, p2 [, p3]])

这意味着第二个和第三个参数是可选的,第三个参数只能在第二个参数存在的情况下使用。

答案 2 :(得分:0)

方括号表示它们是可选参数。您无需传递可选参数。 .animate(properties)会奏效。同样,逗号位于括号内,因为如果它在外面,它们会跟踪

animate(属性,[持续时间])将意味着属性,并且是强制性的,而持续时间不是......它希望: 动画(属性)