【问题标题】:How to understand symbols in documentations [duplicate]如何理解文档中的符号 [重复]
【发布时间】:2021-03-30 15:41:06
【问题描述】:

我正在努力获得阅读文档的良好感觉,而不是到处问这么多问题。

我首先感到困惑的是符号。下面的符号是什么意思?



示例)app.use([path,] callback [, callback...])

参考来源:https://expressjs.com/en/5x/api.html#app.use


问题1&2可以通过类似的贴子解决。

    1. 另一个例子是

bisector.left(array, x[, lo[, hi]])

  • x[, 是什么意思?
  • **lo[,** 是什么意思?
  • ,hi] 是什么意思?

参考来源:https://devdocs.io/d3~5/d3-array#bisect

如果有人能帮助我理解这些神秘符号,将不胜感激。

【问题讨论】:

  • @jonrsharpe 在某种程度上是的,但不完全。但是感谢您的链接
  • 然后edit 澄清您还想知道什么。
  • @jonrsharpe 我认为即使您给我的链接可能会回答第 1 和第 2 个问题,而链接无法回答第 3 个问题,我认为也可以保留第 1 和第 2 个问题让它超级清晰。不喜欢我也可以删。但如果您允许我保持原样,我们将不胜感激。

标签: javascript documentation symbols


【解决方案1】:
  1. [xxx] 表示该参数是可选的。您可以使用或省略它。
  2. [callback] 也是一个可选参数。在这种情况下,它是一个在某些情况下会被调用的函数。
  3. 嵌套bisector.left(array, x[, lo[, hi]]) 意味着您需要有一些选项才能指定其他选项。例如,在这种情况下,如果不先指定 hi,就不能指定 lo

【讨论】:

  • 我怎么知道“需要有一些选项才能指定其他选项”?因为它写在 x[] 中?或者 lo[ 是开方括号??
  • 在这个例子中,你可以通过方括号嵌套的事实知道它。由于arrayx 是强制性的,因此您有3 个选项:array+xarray+x+loarray+x+lo+hi
  • 明白了。但是 1. 我怎么知道哪个可以是 x,比如“x 应该是一个数组,或者 x 应该是一个字符串还是只是变量?2.我怎么知道 'lo[, hi] 表示可选括号内的内容是 [ lo,hi]?如果我理解正确的话。3.括号内的第一个comman是什么意思?,即[,在lo[和hi]之前。jonrsharpe提供的链接说,开头意味着一切都应该链接by ',' 但我没有在 [ , lo[, hi] ] 内得到 , 非常感谢。
  • 1.这个符号不会告诉你变量的类型,它通常写在文档下面的某个地方; 2. 不确定我是否理解; 3. 逗号是参数之间的分隔符,当它在括号内时,表示只有在添加可选参数时才添加这个逗号
猜你喜欢
  • 2020-09-06
  • 1970-01-01
  • 1970-01-01
  • 2011-01-21
  • 1970-01-01
  • 2015-09-12
  • 1970-01-01
  • 2016-08-10
相关资源
最近更新 更多