Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Make the help customiztaion "easier"

未关闭
#2,669 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
csharp
领域
cli

调研方向

先从链接的帮助自定义文档开始,然后追踪 SynchronousCommandLineAction、AsynchronousCommandLineAction、AnonymousSynchronousCommandLineAction、AnonymousAsynchronousCommandLineAction、SetAction,以及根命令对 HelpOption 和 VersionOption 的处理。将提议的 public class、delegate 替代方案和 helper method 与当前 API 进行比较,并将所接受的设计、测试和文档更新定义为完成标准。

由索引模型根据 Issue 内容生成。

描述

The documentation (https://learn.microsoft.com/en-us/dotnet/standard/commandline/how-to-customize-help) shows that when the user wants to customize the help he needs to write a lot of unnecessary code. Create a class which in inherited from SynchronousCommandLineAction / AsynchronousCommandLineAction, find the HelpOption, etc...

I'd suggest you to simplify this.

For example:

  • the AnonymousSynchronousCommandLineAction / AnonymousAsynchronousCommandLineAction classes (which are used in the SetAction methods) could be public. So the user can write this:
                defaultHelpOption.Action = new AnonymousSynchronousCommandLineAction(parseResult =>
                {
                    Console.WriteLine("HEADER");
                    return oldAction.Invoke(parseResult);
                });

  • or replace the XXCommandLineAction classes with just simple delegates:
    public delegate int SynchronousCommandLineAction(ParseResult parseResult);
    public delegate Task<int> AsynchronousCommandLineAction(ParseResult parseResult, CancellationToken cancellationToken);

  • add helper methods to the root command which returns the Help and VersionOptions
主要语言
C#
星标
3.7k
派生
434
平均合并
4 小时 46 分钟
30 天内合并 PR
1

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

dotnet/command-line-api 的其他 Issue

查看 dotnet/command-line-api 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。