dotnet/command-line-api

Examples of program usage

Open

#400 ouverte le 30 janv. 2019

Voir sur GitHub
 (11 commentaires) (1 réaction) (0 assignés)C# (3 665 stars) (421 forks)auto 404
Area-Helpenhancementhelp wanted

Description

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'?

Guide contributeur

Stack technique
csharp
Domaine
clideveloper experience
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
basic C#familiarity with System.CommandLine
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
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.