在命令行中,查看一個命令的幫助,會得到一些格式非常清晰的文檔。因爲這種文檔格式非常清晰,一般情況下,大家都能大概理解文檔的意思。但是隻有了解了文檔的格式,才能真正讀懂文檔包含的所有信息。
如下面的截圖所示,這個是通過git --help獲取的幫助文檔。文檔中的[xxx],--xxx,<xxx>等具體表示什麼意思呢?哪些是必須要填的參數哪些是可選的呢?要了解這些,我們需要學習一種格式語言。這種語言叫做的’命令行接口描述語言‘,英文名字叫做’command-line interface description language‘。大多數的命令行的幫助文檔都是遵循該語言的規範撰寫的。
本文重要介紹該語言中四個常用的格式。
1、位置參數(ARGMENT)
<xxx>中xxx表示的是位置參數。位置參數
2、選項(OPTION)
-x表示短選項,--xx表示長選項。多個短選項可以合併,例如-abc相當於-a -b -c。短選項後面可以跟參數(假設短選項名爲x,長選項名爲xx,參數是FIle),格式爲-x File活着-xFile。長選項後面也可以跟參數,格式是爲--xx=File活着--xx File。
3、子命令
所有沒有跟OPTION和ARGMENT的單詞都認爲是該命令的子命令。
4、可選元素
通過用一對中括號包起來的都是可選的。例如下圖中[--version]就是一個可選的。
(更多有關命令行接口描述語言的內容可以參見此處:http://docopt.org)