FAQ, Q7: The example code makes no sense

Offen

#939 erstellt am 30.11.2024 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: csharp
Bereich: cli, documentation

Rechercherichtung

Beginnen Sie mit dem Q7-Eintrag im CommandLine-Wiki und überprüfen Sie das dort beschriebene Verhalten von HeadingInfo und der Standard-Hilfe-Engine. Aktualisieren Sie das Beispiel so, dass es die Anpassung der standardmäßigen Hilfeausgabe einschließlich der Verarbeitung von --version demonstriert, und stellen Sie sicher, dass das resultierende Beispiel die angezeigten Versionsinformationen erklärt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Hello,

thanks a lot for sharing your great and useful work!

I probably have just a small issue to Q7
https://github.com/commandlineparser/commandline/wiki/How-To#q7
with this question:

How to Display version information on Application startup?

The example code looks like this:

var title=new HeadingInfo(programName:"My supper Application",version:"1.2.3; App-Server:3.6.7");
Console.WriteLine( title );

// The Result will be:
My supper Application 1.2.3; App-Server:3.6.7

This example code makes no sense, because the code does nothing more than we could achieve with this code:

Console.WriteLine( "My supper Application 1.2.3; App-Server:3.6.7" );

The example should display how we can modify the default help engine, including the default `--version` parameter handling

so that the default help automatically uses this new HeadingInfo 😀

Describe the bug
It is a bug in the sense that the example code in the FAQ unfortunately does not show a relevant use-case on how to use HeadingInfo.

Expected behavior
It would be great if the example code shows how we can slightly modify the default behavior of the help engine.

Thanks a lot, kind regards,
Thomas

Vorherrschende Sprache: C#
Sterne: 4.8k
Forks: 478
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus commandlineparser/commandline

Join IEnumerable defaults with separator instead of space Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

commandlineparser/commandline#951 · 1 Kommentar · Erstellt am 19.5.2026
Code example misses iEnumerable Offen

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 70/100

commandlineparser/commandline#880 · 2 Reaktionen · Erstellt am 22.3.2023
Is it possible to create options with conditional parameters with help generation like in linux tail? Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 45/100

commandlineparser/commandline#952 · Erstellt am 16.6.2026
How to add custom help while keeping default verb help Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100

commandlineparser/commandline#948 · Erstellt am 20.10.2025
How to add examples for verbs? Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100

commandlineparser/commandline#947 · Erstellt am 20.10.2025

Alle Issues in commandlineparser/commandline