Что означают скобки вокруг аргументов при чтении документации для метода? [дубликат]

этот вопрос уже есть ответ здесь:

часто при чтении документации о том, какие аргументы могут быть переданы методу, я вижу скобки, используемые в списке аргументов, например:

example of brackets used within arguments on method documentation

Что делают скобки имею в виду в этом контексте? Почему запятые внутри в скобках?

9
api javascript

3 ответов

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

Это почти всегда так.

16

скобки вокруг параметра означают, что он является необязательным.

когда пишется отдельно, это означает, что вы можете использовать любой из параметров в любой комбинации. Метод определяет, что вы используете тип данных значений. Все эти комбинации могут быть использованы для этого метода:

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

Это означает, что второй и третий параметры необязательно, и третий параметр может использоваться только в том случае, если есть второй параметр.

3

квадратные скобки означают, что они являются необязательными параметрами. Необязательно передавать необязательные параметры. .animate(properties) будет работать . Также запятые находятся внутри скобки, потому что если бы она была снаружи, они бы следовали

animate (properties, [duration]) будет означать свойства и , являются обязательными, в то время как продолжительность не является... Он хотел бы : анимировать(свойства)

0