Gibt es einen Standard für die Reihenfolge der Argumente, die in der Verwendungsanweisung eines Befehlszeilen -Tools gedruckt wurden? [abgeschlossen
-
25-09-2019 - |
Frage
Grüße an meine verehrten Experten!
Ich schreibe ein Befehlszeilen-Tool (ähnlich wie LS oder Katze oder Uname usw.) und ich habe mich gefragt, ob es einen Best-Practice gibt, um die Argumente in der Verwendungsrechnung zu bestellen.
Ich bin verwirrt, weil, ls
Die Nutzungsaussage druckt Argumente in alphabetischer Reihenfolge, wobei A. cat
Die Nutzungsaussage ist nicht!
Versuchen cat --help
und ls --help
.
Können Sie mich auch auf eine Dokumentation verweisen, wenn es einen Standard gibt?
Lösung
Ha, Standard! Nein, sicherlich nichts dergleichen. Wählen Sie Ihren Favoriten aus, was auch immer gut aussieht und gut organisiert ist und bereits auf dem Computer ist, und nachahmen Sie ihn nach.
Meine Meinungen folgen:
- Ich sehe keinen Wert in alphabetischer Wert.
- Bestellen Sie es logischerweise, in Kategorien arrangiert und zuerst nützliche Dinge eingeben.
- Stellen Sie sicher, dass der Parsing -Motor solide und "Standard" ist, bevorzugte vorzugsweise die eines anderen. Boost's Programmoptionen oder Python Optparse sind gut, wenn sie für Sie in der richtigen Sprache sind. Die meisten anderen Sprachen haben auch einige.
- Stellen Sie sicher, dass Sie viele Beispiele enthalten, die den Gebrauchsumfang umfassen.
Andere Tipps
Kein Standard so
Wie bei allen Dokumentationen und technischem Schreiben müssen Sie zuerst über Ihr Publikum entscheiden.
Zum Beispiel, wenn Sie herausfinden möchten, wie man bekommt sort
Um den Fall zu ignorieren, wissen Sie selten schon, dass dies der Fall ist -f
(Fold Case, an wen zum Teufel dachte das?). Die nützlichste Ausgabe hätte einen Abschnitt zu Datenumwandlungsoptionen (z. B. Fall ignorieren, die akzentuierten Zeichen als nicht akzentuiert behandeln), ein weiteres für die Schlüsselauswahl (z. , Zusammenstellung) und so weiter.
In jedem Fall ist die Art von Person, die bereits weiß, dass es die ist -f
Die Option wird auch wissen, wie man benutzt less
Um nach dieser Option zu suchen, ohne die Unmengen unnötiger Informationen durchführen zu müssen :-)
Tatsächlich würde ich einen besser gehen. Haben zwei mögliche Ausgänge. Machen Sie die Standardeinstellung zu einem nutzungsbasierten Format, machen Sie jedoch die erste Verwendung zu einer Möglichkeit, eine alphabetische Auflistung zu erhalten:
pax> paxprog --help
paxprog - truly an amazing program.
paxprog is capable of doing anything you want.
Help output options:
--help
Usage-based assistance (default).
--alpha-help
All options in alphabetical order.
Coffee-making options:
--temp=chilled|tepid|hot|damnhot
Selects the temperature.
Blah, blah, blah ...
Es gibt mit Sicherheit ein Standard: http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/v1_chap12.html. Hinweis Absatz 3: "Die Optionen werden normalerweise in alphabetischer Reihenfolge aufgeführt, es sei denn, dies würde die Versorgungsbeschreibung verwirrender machen."
Es gibt keinen Standard, obwohl es einige allgemeine Konventionen gibt, die, wie ich davon ausnehme, bereits vertraut sind. Es ist jedoch nicht 100%.