commandlineparser / commandlineparser/commandline

SetName specific help text

Offen
#870 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
C#
Sterne
4.8k
Forks
478
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Propose a smarter help text when SetName exists, prefer separated help text based on SetName, because the current help text doesn't tell users options in different SetNames are exclusive.

we could have help text as below:

**web** command:

--documentroot

--enablejavascript

-r

--help Display this help screen.

--version Display version information.

**ftp** command:

--ftpdirectory

--anonymouslogin

-r

--help Display this help screen.

--version Display version information.

Example option:

public class OptionsMutuallyExclusive
{
//Implement commands in set(group) named web
[Option(SetName = "web")]
public string DocumentRoot
{
get;
set;
}

[Option(SetName = "web")]
public bool EnableJavaScript
{
get;
set;
}

//Implement other commands in set(group) named ftp
[Option(SetName = "ftp")]
public string FtpDirectory
{
get;
set;
}

[Option(SetName = "ftp")]
public bool AnonymousLogin
{
get;
set;
}

//Common option, can be used with any set because it's not included in a set
[Option('r')]
public string UrlAddress
{
get;
set;
}
}

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginne damit, den Einstiegspunkt für die Generierung des Hilfetexts und die Verarbeitung von Option-Attributen mit SetName zu finden. Vergleiche die aktuelle Ausgabe mit der vorgeschlagenen Gruppierung von web und ftp, einschließlich gemeinsamer Optionen wie -r, --help und --version. Als erledigt gilt die Aufgabe, wenn die generierte Hilfe sich gegenseitig ausschließende Mengen klar voneinander trennt und dabei gemeinsame Optionen beibehält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
cli
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.