首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >为什么编程文档在奇怪的地方有方括号和逗号?

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

Stack Overflow用户
提问于 2015-08-15 05:04:15
回答 1查看 159关注 0票数 0

为什么在不同的函数编程文档中,它们都有方括号将参数括起来,但它们的顺序却使后面的参数看起来像是第一个参数的子集?或者如果该语言中的括号描述了数组,就好像第二个参数应该在第一个参数的数组中,但通常参数甚至不应该是数组,而且它们在奇怪的地方有逗号。

我在各处都看到了这种风格,并试图找到一些地方,记录下他们为什么要这样做。也许有人武断地决定了这一点,而其他程序员认为,“哦,这看起来很酷,我会在编写自己的文档时尝试这样做……”或者可能有一本关于如何编写编程文档的规则大全?如果是这样的话,我想了解一下。这里有一个例子:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice,如果你转到页面右下角的蓝色框中的链接,在h2下面?它的标题“语法”是这样的:对于切片方法,arr.slice([begin[, end]])表示第一个参数是begin,下一个参数是end。当您第一次看到这样的内容时,看起来括号和逗号是随机放置的。但他们到处都是这样做的,而且都是一样的。一定有什么方法可以达到疯狂的效果!

EN

回答 1

Stack Overflow用户

发布于 2015-08-15 05:11:04

参数名称周围的括号表示它是可选参数。例如,您可以调用没有end参数的slice方法。这只是语言语法文档的一般规则,方括号表示可选的单词/标记。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/32018625

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档