dotnet/command-line-api

Examples of program usage

Open

#400 aberto em 30 de jan. de 2019

Ver no GitHub
 (11 comments) (1 reaction) (0 assignees)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'?

Guia do colaborador

Pilha de tecnologia
csharp
Domain
clideveloper experience
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
half day
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
basic C#familiarity with System.CommandLine
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60
Direção de pesquisa
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.