FAQ, Q7: The example code makes no sense
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- csharp
- 領域
- cli, documentation
調査の方向性
CommandLine wiki の Q7 エントリから始め、そこに記載されている HeadingInfo とデフォルトのヘルプエンジンの動作を確認してください。デフォルトのヘルプ出力のカスタマイズ（--version の処理を含む）を示すように例を更新し、結果の例で表示されるバージョン情報を説明できるようにしてください。
索引モデルが issue の本文から書いたものです。
説明
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
- 主要言語
- C#
- スター
- 4.8k
- フォーク
- 478
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
commandlineparser/commandline のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
commandlineparser/commandline#951 · コメント 1 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 70/100
commandlineparser/commandline#880 · リアクション 2 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 45/100
commandlineparser/commandline#952 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
commandlineparser/commandline#948 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
commandlineparser/commandline#947 ·
commandlineparser/commandline の issue をすべて見る
似ている issue
-
core dependencies
難易度 1/5 1時間未満 初心者へのやさしさ 80/100
-
bug frontend good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
NavigationViewItemAutomationPeer implements IInvokeProvider but never advertises the Invoke pattern オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
unoplatform/uno#24629 ·
-
agentic-workflows Needs: Triage :mag: State: In-PR
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
Down / Waiting for removal
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100