函数文档中的类似数组的参数

时间:2019-01-25 21:18:17

标签: methods parameters arguments documentation

很抱歉,如果我的问题很愚蠢,我们所有人都已经看到了很多关于此文档方法的函数自变量

redis.createClient(port[, host][, options])

我无法理解port的工作原理,以及为什么host参数位于数组中并且以,开头的原因。上面的摘录来自

https://github.com/NodeRedis/node_redis

谢谢

1 个答案:

答案 0 :(得分:1)

它不是数组。方括号通常以这种方式用于指示可选参数。

基本上,这意味着您可以将其用作以下任意一项:

  • redis.createClient(port)
  • redis.createClient(port, host)
  • redis.createClient(port, options)
  • redis.createClient(port, host, options)

有时使用符号redis.createClient(port[, host[, options]])代替,这意味着不可能将其用作redis.createClient(port, options)

在记录命令时也使用类似的符号。 (例如,来自ls手册:ls [OPTION]... [FILE]...