commandlineparser / commandlineparser/commandline

FAQ, Q7: The example code makes no sense

Aberta
#939 0 comentários 0 reações 0 responsáveis Ver no GitHub
Linguagem predominante
C#
Estrelas
4.8k
Forks
478
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Direção de pesquisa

Comece pela entrada Q7 na wiki do CommandLine e revise o comportamento de HeadingInfo e do mecanismo de ajuda padrão descrito nela. Atualize o exemplo para demonstrar a personalização da saída de ajuda padrão, incluindo o tratamento de --version, e certifique-se de que o exemplo resultante explique as informações de versão exibidas.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
csharp
Domínio
cli, documentation
Tipo de issue
Documentação
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.