【问题标题】:Array like argument in function documentation函数文档中的类似参数的数组
【发布时间】:2019-06-19 17:42:27
【问题描述】:

对不起,如果我的问题很愚蠢,我们所有人都已经看到许多方法的函数参数记录为这样

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

我无法理解 port 的工作原理以及为什么 host 参数在数组中并且以 , 开头。上面的sn-p来自

https://github.com/NodeRedis/node_redis

谢谢

【问题讨论】:

    标签: methods parameters arguments documentation


    【解决方案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]...

    【讨论】:

      猜你喜欢
      • 2017-03-01
      • 2023-03-24
      • 2013-07-25
      • 2013-06-12
      • 2019-11-21
      • 2023-01-08
      • 1970-01-01
      • 2016-08-23
      • 1970-01-01
      相关资源
      最近更新 更多