[发明专利]一种命令行参数格式表示结构及方法

说明书

技术领域

本发明属于命令行表示领域，具体涉及一种命令行参数格式表示结构及方法。

背景技术

命令行界面是最古老的操作系统交互界面，通过键盘输入命令对系统发出指令。因实际使用需要，各个命令经常带有一些‘参数’，作为对命令执行具体细节的补充说明。不同的命令因使用场景及功能不同，参数的形态也不一样。常见的参数限制有：长短参数，可选参数，带操作数的参数，互斥参数，顺序参数，不定操作数的参数，默认参数等几种形式。因此针对初次使用的用户，需要对参数的格式及限制做出说明。各种各样的命令行格式表示法应运而生。目前最常用的命令行参数格式表示方法在Unix系操作系统中，该方法使用 -表示短参数 --表示长参数，[]表示可选参数，空格表示带操作数的参数， … 表示不定操作数的参数。如图1所示的这套方法解决了命令行参数格式的问题，并逐渐流行开来成为了行业通用的标准。但是随着命令的参数格式越来越复杂，这套表示法也暴露出对用户不友好，表现力不够等缺点，使用户无法直观地了解命令的使用方法。

此为现有技术的不足，因此，针对现有技术中的上述缺陷，提供一种命令行参数格式表示结构及方法，是非常有必要的。

发明内容

本发明的目的在于，针对上述现有技术的命令行参数格式表示方法对用户不友好，表现力不够的缺陷，提供一种命令行参数格式表示结构及方法，以解决上述技术问题。

为实现上述目的，本发明给出以下技术方案：

一种命令行参数格式表示结构，包括命令名称、行数标记以及参数列表；

命令名称，用于设置在命令行的第一列第一行表示命令名称；

行数标记，用于设置在命令行第二列标记命令格式的行数；行数标记与命令名称之间设置间隔；行数标记采用数字后跟“>”符号表示；

参数列表，用于从命令行第三列开始将所有参数展开罗列，同一行相邻两个参数之间设置间隔；每个参数通过参数表示单元表示；参数列表与行数标记之间设置间隔。

进一步地，行数标记与命令行之间设置一个空格的间隔。

进一步地，参数列表与行数标记之间设置两个空格的间隔。

进一步地，同一行两个参数之间设置一个空格的间隔。

进一步地，参数表示单元包括长参数表示单元、短参数表示单元、参数所需操作数表示单元、可选内容参数表示单元、不定操作数参数表示单元、互斥参数表示单元或者必选参数表示单元；同一个参数的长参数表示单元和短参数表示单元不能同时使用；

长参数表示单元又叫全称参数表示单元，长参数表示单元采用“--”符号后跟长参数；短参数表示单元又叫简写参数表示单元，短参数表示单元采用“-”符号后跟短参数；参数所需操作数表示单元采用“<>”符号表示该参数所需操作数；可选内容参数表示单元采用“[]”符号表示该参数内部的内容为可选内容；必选参数表示单元采用 “*”后跟必选参数；不定操作数参数表示单元采用“...”表示该符号之前的参数或操作数的数量可由用户自行制定；

互斥参数表示单元，用垂直罗列的字段表示相邻前一个参数的互斥操作数，各字段之间互斥，不能同时出现在相邻前一个参数之后，一个互斥参数表示单元用多行表示，不增加新的行数标记；

必选参数表示单元，用垂直罗列的字段表示相邻前一个参数的必选操作数，各字段之间互斥，不能出现在相邻前一个参数之后，一个必选参数表示单元用多行表示，不增加新的行数标记。

本发明还给出如下技术方案：

一种命令行参数格式表示方法，包括如下步骤：

在命令行的第一列第一行设置命令名称；

在命令行的第二列设置行数标记；行数标记与命令名称之间设置间隔；行数标记采用数字后跟“>”符号表示；

从命令行第三列开始将所有参数展开罗列，同一行相邻两个参数之间设置间隔；每个参数通过参数表示单元表示；参数列表与行数标记之间设置间隔。

进一步地，行数标记与命令行之间设置一个空格的间隔。

进一步地，参数列表与行数标记之间设置两个空格的间隔。

进一步地，同一行相邻两个参数之间设置一个空格的间隔。

进一步地，参数表示单元包括长参数表示单元、短参数表示单元、参数所需操作数表示单元、可选内容参数表示单元、不定操作数参数表示单元、互斥参数表示单元或者必选参数表示单元；同一个参数的长参数表示单元和短参数表示单元不能同时使用；