commandlineparser / commandlineparser/commandline
Add short application description under name on all help screens
- 主要語言
- C#
- 星號
- 4.8k
- 分支
- 478
- PR 合併指標
- 30 天內沒有已合併 PR
描述
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.
貢獻指南
這個儲存庫沒有索引到貢獻指南
研究方向
首先追蹤應用程式的頂層說明畫面是如何組裝的,以及應用程式名稱、版本和版權資訊寫入的位置。檢查那裡是否可以使用 System.Reflection.AssemblyDescriptionAttribute 作為描述來源。完成的標準是:簡短描述顯示在所有相關說明畫面的名稱下方,同時不影響現有的命令說明和版本說明。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- csharp
- 領域
- cli
- Issue 類型
- 功能
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100