JavaScript API文档-functionName([value[，arguments]]）表示法是什么意思

JavaScript API documentation - what does functionName([value[, arguments]]) notation mean?

本文关键字：表示 意思 是什么 arguments 文档 API -functionName value JavaScript      更新时间：2023-09-26

这个问题与：如何为新手阅读API文档有关？。然而，这个问题并没有涵盖我在这里询问的有嵌套括号的特定格式（例如，[value[, args]]）。

虽然，我认为这可能与任何API有关，但我正在研究D3.js API，特别是transition.ease()。我搞不懂下面的意思：

transition.ease([value[, arguments]])

很难找到，因为我不知道谷歌的搜索词是什么！我只想知道：

  1. 它应该如何阅读
  2. 它是通用/普通的符号吗

我知道如何使用D3函数；这只是我感兴趣的符号。

transition.ease([value[, arguments]])的文档似乎相对清楚地表明了他们想要说的内容。此外，对于在[]中具有可选参数的方法，它遵循"正常"语法。

在这种情况下，意味着ease()是transition的方法。对于ease()方法：([value[, arguments]])，表示传递任何参数都是可选的。那么，value[, arguments]意味着，如果存在value自变量，则可以可选地存在不受限制数量的附加arguments。我说"意在意味着"，因为通常能够有一个自变量的倍数是用椭圆...表示的。因此，这通常是：value[, arguments...]。通过进一步查看文档，可以清楚地看出，这正是我们的意图。

分析文档（我提供额外格式）：

指定过渡缓和函数。

如果值是一个函数，则用于简化当前参数定时值t，该值通常在[0,1]范围内。（在转换结束时，t可能略大于1。）

您可以将函数作为参数传递给transition.ease()。如果您这样做了，那么它将被用作确定转换是如何发生的函数。

否则，值被假定为一个字符串，并且参数被传递给d3.ease方法以生成一个宽松函数。默认的宽松函数是"立方进立方出"。请注意，不可能按元素或按属性自定义缓和函数；但是，如果使用"线性"缓和函数，则可以使用attrTween或styleTween在插值器内应用自定义缓和。

如果value不是函数，则假定您将使用d3.ease()作为转换函数。在这种情况下，transition.ease()的所有自变量都传递给d3.ease()。d3.ease()假设value（在d3.ease()写入中称为type）是一个字符串。d3.ease(type[, arguments…])能够接受额外的可选参数。为了给d3.ease()函数指定所需的任何其他参数，transition.ease()还可以接受这些参数并将其传递给d3.ease()。

注意：从transition.ease()和d3.ease()之间的交互来看，transition.ease([value[, arguments]])实际上应该用椭圆写成transition.ease([value[, arguments..]])。如果这不是预期用途，那么所描述的与d3.ease()的交互将没有意义。

如果未指定ease，则返回绑定到转换中第一个非null元素的easing函数。

这实际上并不清楚。我预计它包含一个错误，即"ease"应该是"值。在这种情况下，它将显示为：

如果未指定值，则返回绑定到转换中第一个非null元素的宽松函数。

如果这确实是预期的，那么不为transition.ease()指定任何参数将导致返回绑定到转换中第一个非null元素的宽松函数作为返回值。这将是不向此类函数提供任何参数的正常和预期用途。因此，我认为这个问题很可能真的是文件中的一个错误。这可以通过查看源代码或通过实验来验证。

这意味着value和arguments是可选的。

相关文章：