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

IT技术 javascript api
2021-01-29 19:48:13

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

在方法文档的参数中使用的括号示例

在这种情况下,括号是什么意思?为什么括号有逗号

3个回答

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

这几乎总是如此。

直到!我一直想知道 [<x>,<y>]语法。
2021-03-21 19:48:13
我很震惊,更多的教程没有更多地解释符号。假设人们知道 [, param] 的含义是错误的。谢谢你的好答案。
2021-03-28 19:48:13

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

当像这样单独编写时,这意味着您可以任意组合使用任何参数。该方法根据值的数据类型确定您使用的内容。所有这些组合都可以用于该方法:

.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]])

这意味着第二个和第三个参数是可选的,并且只有在第二个参数存在时才能使用第三个参数。

你有4个参数吗?p4在哪里?
2021-03-16 19:48:13

方括号表示它们是可选参数。您不需要传递可选参数。.animate(properties)将工作 。逗号也在括号内,因为如果它在外面,它们会拖尾

animate(properties, [duration]) 表示属性和 , 是强制性的,而持续时间不是......它想要: animate(properties,)