commandlineparser / commandlineparser/commandline

FAQ, Q7: The example code makes no sense

Đang mở
#939 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
C#
Star
4.8k
Fork
478
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Hướng nghiên cứu

Bắt đầu với mục Q7 trong wiki của CommandLine và xem lại hành vi của HeadingInfo cũng như help engine mặc định được mô tả ở đó. Cập nhật ví dụ để minh họa việc tùy chỉnh đầu ra trợ giúp mặc định, bao gồm cả việc xử lý --version, và đảm bảo ví dụ sau khi cập nhật giải thích thông tin phiên bản được hiển thị.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
csharp
Lĩnh vực
cli, documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.