2017-07-26 2 views
0

Da jemand, von dem wir wissen, dass das Benennen von Variablen eines der komplexesten Software-Engineering-Probleme ist ..., scheint es, dass Sie es erst bemerken, wenn Sie sich ihm stellen.Wie werden Variablen oder Argumente mit doppeltem Plural benannt?

Hier ist das aktuelle Dilemma eines realen Beispiels: Hinzufügen eines CLI-Parameters, der es dem Benutzer ermöglichen würde, in dem/den Format (en) der Datei (en) anzugeben, die im Rahmen der Testausführung generiert werden.

In den meisten Fällen wird nur eine Datei in einem einzigen Format generiert, aber wenn es möglich ist, mehrere Dateien zu erhalten und auch mehrere Ausgabeformate anzufordern, verwenden Sie eine durch Befehle getrennte Liste von Werten, wie --controversial-param=junitxml,html.

Basierend auf Namen, die sich um ging, kam ich zu dem Eindruck auf, dass der Gewinner wird wahrscheinlich ein, dass dieses Muster ist passend:

--(output|report|result)[s]?-format[s]? 

ich argumentiert gegen eine doppelte Plurale verwenden, weil sie grammatisch falsch sind. Der zweite Grund gegen Plural (im Allgemeinen) war, dass sie zu Verwirrungen führen würden: Es wäre zu einfach für jemanden, einen Parameter hinzuzufügen und zu vergessen, den Plural hinzuzufügen, den Code-Review zu übergeben und nach der Zusammenführung fehlzuschlagen. Ich habe diese Art von Fehlern schon oft in der Vergangenheit gesehen, mir ist sogar passiert, dass ich den "Tippfehler" gemacht habe, oder ihn während des Review-Prozesses vermisst habe.

So verlasse ich mich auf andere SO-Community zu schlagen und zu wählen eine Lösung. Lassen Sie das beste Argument gewinnen und nutzen Sie Argumente statt persönlicher Präferenzen.

+0

Gibt mehrere Werte vorbei bedeuten, dass alle Ausgabedateien in _all_ die Formate angegeben erzeugt werden? Wenn ja, dann ist es einfacher als Sie denken: '--output-formats' ist vollkommen in Ordnung, das Wort" output "kann jede Menge Zeug bezeichnen, von nichts bis zu vielen Dateien und" formats "kann auch enthält null oder ein einzelnes Format. Es gibt andere Fälle, in denen doppelte Pluralformen wirklich benötigt würden und die Unmöglichkeit, Apostrophe zu verwenden, Kopfschmerzen bereiten kann. – gbr

+0

@gbr bitte machen Sie eine Antwort! – sorin

+0

Hier sind Sie .... – gbr

Antwort

0

Basierend auf Popularität (google Suchergebnisse) und die bisherigen Erfahrungen mit anderen Werkzeugen, die ich

--output-format 

Keine gar Plurale vorschlagen würde, sondern ein Befehl getrennte Liste zuzugreifen, diese wenn --help Verwendung dokumentiert.

0

Wenn mehrere Werte Ihren Parameter übergeben bedeutet, dass alle Ausgabedateien in allen Formaten angegeben, ist es in diesem Fall erzeugt werden einfacher als Sie denken:

--output-formats völlig in Ordnung ist, wird das Wort "Ausgang "kann eine beliebige Menge an Material bezeichnen, von nichts bis zu einer Datei und" Formate "kann auch null oder ein einzelnes Format enthalten.

Es gibt andere Fälle, in denen Doppel Plurale wirklich benötigt würde, und die Unmöglichkeit, Apostrophe zu verwenden geben Kopfschmerzen Sie

Verwandte Themen