为什么编程文档在奇怪的地方有方括号和逗号？

-1

为什么在函数的各种编程文档中，它们都有方括号围绕着参数，但是它们的排列方式使后面的参数看起来像是第一个参数的子集？或者，如果该语言中的括号描述数组，就好像第二个参数应该在第一个数组中，但通常参数甚至不应该是数组，并且它们在奇怪的地方也有逗号。为什么编程文档在奇怪的地方有方括号和逗号？

我已经看到了这个风格到处都是，并试图找到一些地方写下来，为什么他们这样做。也许有人随意决定和其他程序员认为，“哦，看起来很酷，我会尝试写我自己的文档..” 或者也许有一些关于如何编程文档的规则大书？如果是这样我想知道它。这里是一个例子：https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice 如果你去的页面顶部附近的蓝色框中的链接右下方的h2？标题“语法”它说：arr.slice([begin[, end]])这意味着第一个参数是开始，并且下一个参数是结束，为切片方法。当你第一次看到类似这样的东西时，它看起来像括号和逗号是随机放置的......但它们在整个地方以同样的方式进行。必须有一些疯狂的方法！

来源

2015-08-14 Brew Dain

参数名称周围的括号表示它是一个可选参数。例如。你可以调用slice方法而不用结束参数。这只是语言语法文档的一般规则，方括号表示可选词/标记。

来源

2015-08-14 21:11:04

好的，但为什么不是'arr.slice（[开始]，[结束]）'？为什么分层就像一个在另一个内部？ –

外括号表示切片可以有零参数，即整个参数部分是可选的。 “begin”周围没有括号的事实表明，如果提供了任何参数，则第一个参数是begin。围绕“，end”的内括号表示如果提供了begin，那么你也可以选择提供end。你写的方式意味着你可以不用开始就结束，但根据规范这是无效的。 –

更具体地说，我认为原因是*逗号*也是可选的，并且应该在“结束”时出现。如果你认为当这种东西变得普遍时，这更有意义，它也用于例如命令行实用程序不与任何特定的编程语言相关联。 –

为什么编程文档在奇怪的地方有方括号和逗号？

回答

相关问题