爲什麼編程文檔在奇怪的地方有方括號和逗號？

-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。你寫的方式意味着你可以不用開始就結束，但根據規範這是無效的。 –

更具體地說，我認爲原因是*逗號*也是可選的，並且應該在「結束」時出現。如果你認爲當這種東西變得普遍時，這更有意義，它也用於例如命令行實用程序不與任何特定的編程語言相關聯。 –

爲什麼編程文檔在奇怪的地方有方括號和逗號？

回答

相關問題