[Docpie]

Fork me on GitHub

Options格式


"Options"列出了所有可以作用在[options]中的Option

"Options"按惯例以"Options:"不区分大小写)开头,用空行与其它部分隔开。其中可以声明:

  • Option的别名
  • Option的描述
  • Option是否接受参数以及参数的默认值

别名和参数

相同Option不同名字通过空格分开,你也可以额外加一个空格

-h, -?, --help    # with comma
-v --version      # without comma

如果需要参数,则参数用空格分开写在后面。对于长Option可以用=指明。你不必为每个同名Option都写一遍参数。

-r <file> --read <file>     # without `=`
-w FILE --write=FILE        # with`=`
-x --exexecute=<file>

描述

描述可以让人知道这个Option是人是鬼。描述至少用两个空格与Option隔开,或者另起一行,比Option多敲两个空格即可。如果一个描述需要分行,则每行保持其缩进就好:

-l --logging             open the logging.             # Good. Inline description
-r <file> --read <file>  read the data from the file.  # Good, 2 spaces
                         if the file does not exists, create one. 
                         # Good, keep the indent
-w FILE --write=FILE
        write the data to the file  # Good, new line indent 2 more spaces
        create one if not exists    # Good, keep the indent
        raise RuntimeError if fails to create
        raise IOError if fails to write

默认值

接受参数的Option可以指定参数的默认值。默认值只需要把"[default: 你的默认值]"写在描述末尾即可。注意:后面有个空格。

--speed=<km/h>    the speed of the ship.[default: inf]    # 'inf'
--ship=<name>     the name of the ship
                  create one if not exist. [default: ]    # an empty string

如果你喜欢这个项目,可以买我一杯啤酒,让我做的更好! | Flattr this

侧栏导航