Hin und wieder führen wir hier intern Diskussionen um Standards und Normen, gerade dann, wenn man eigene Software entwickelt.
Auch immer wieder mal ein Thema: Die Angabe von Kommandozeilenparametern, genauer: Die Syntax-Angabe (z.B. bei
--help
). Einen wirklich einheitlichen Standard, z.B. für Linux/UNIX, ist nicht aufzutreiben, daher ist es ratsam, sich intern einen Standard zuzulegen.
Quasi-Standard ist
[bar]
zur Angabe von optionalen Parametern, z.B.
Usage: foo -o [bar]
|
für Alternativen, wie z.B.
Usage: foo
und
...
für wiederholbare Parameter oder kontextabhängige Optionen, z.B.
Usage: foo add ...
Nicht ganz standardisiert sind Angaben verpflichtender Angaben, diese werden teilweise als
<bar>
oder als
{bar}
geschrieben. Dazu kommt dann noch, wenn diese verpflichtenden Angaben Freitext-Angaben sind, oder eben aus einer vorgebenen Liste stammen sollen, ergo z.B.
Usage: foo -b {src|dest}
Usage: foo -b <src|dest>
Usage: foo -b <ipaddress>
Über Eure Meinungen zu dem Thema, Euer Handling etc. freue ich mich!