commandlineparser / commandlineparser/commandline

Add short application description under name on all help screens

Aberta
#338 2 comentários 5 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

Currently if I type application name help screen does not contain any short description of application. If I use help on windows dir command:
```
`C:\Users\Example>dir /?
Displays a list of files and subdirectories in a directory.

...help text continues
```
I think that it's nice way of communicating for user, what this tool does (in few words).

Current output:
```
>MyApp.exe
MyApp 1.0.0
Copyright (C) 2018 MyApp

verb1 Help text for verb 1
verb2 Help text for verb 2
help Display more information on a specific command.
version Display version information.
```

Would be nice output:
```
>MyApp.exe
MyApp 1.0.0
Utility for mass renaming files
Copyright (C) 2018 MyApp

verb1 Help text for verb 1
verb2 Help text for verb 2
help Display more information on a specific command.
version Display version information.
```

I think System.Reflection.AssemblyDescriptionAttribute would be good source of this description.

Guia de contribuição

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

Direção de pesquisa

Comece rastreando como a tela de ajuda de nível superior da aplicação é montada e onde o nome da aplicação, a versão e os direitos autorais são escritos. Verifique se System.Reflection.AssemblyDescriptionAttribute está disponível nesse local como fonte da descrição. Está concluído quando a descrição curta aparece abaixo do nome em todas as telas de ajuda relevantes sem interromper a ajuda existente de comandos e versão.

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

Avaliação

Stack de tecnologia
csharp
Domínio
cli
Tipo de issue
Funcionalidade
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.