dotnet/command-line-api

Examples of program usage

Open

#400 geöffnet am 30. Jan. 2019

Auf GitHub ansehen
 (11 Kommentare) (1 Reaktion) (0 zugewiesene Personen)C# (3.665 Stars) (421 Forks)auto 404
Area-Helpenhancementhelp wanted

Beschreibung

CommandLineParser supports of printing examples of program usage: There is examples ot this feature in BenchmarkDotNet:

https://github.com/dotnet/BenchmarkDotNet/blob/adde64cbbcde01938d6b2772066852c4f6c0e88d/src/BenchmarkDotNet/ConsoleArguments/CommandLineOptions.cs#L151-L178

Is there an equivalent of this function in `System.Command Line'?

Contributor Guide

Tech Stack
csharp
Domain
clideveloper experience
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
basic C#familiarity with System.CommandLine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
Examine the BenchmarkDotNet example referenced in the issue (CommandLineOptions.cs lines 151-178) to understand how program usage examples are printed there. Investigate the current System.CommandLine help system in the repository to identify where similar functionality could be added, and consider proposing a design that mimics the approach used in BenchmarkDotNet.