PowerArgs 技术文档

本文档将为您提供 PowerArgs 的安装指南、使用说明以及项目 API 使用文档，帮助您详细了解并使用该项目。

1. 安装指南

PowerArgs 可在 官方 NuGet 仓库 获取。

若要构建具有文本图形的命令行应用程序，可以尝试使用 klooie。

2. 项目使用说明

PowerArgs 能够将命令行参数转换为易于使用的 .NET 对象。此外，它还提供了许多额外的可选功能，例如参数验证、自动生成使用说明、制表符补全以及丰富的扩展性。您甚至可以构建一个完整的、交互式文本 UI 应用程序。

PowerArgs 还可以协调程序的执行，为您提供以下好处：

• 一致的、自然的用户错误处理
• 根据操作（例如 'git push' 或 'git pull'）调用正确的代码
• 专注于编写您的代码

3. 项目 API 使用文档

以下是一些关键 API 和特性的使用说明：

• ArgRequired: 标记必须指定的参数。
• ArgRange: 指定参数值应在某个范围内。
• ArgShortcut: 为参数提供快捷方式。
• ArgDescription: 提供参数的描述信息。
• ArgExample: 为参数提供示例用法。
• HelpHook: 在布尔型参数上使用，显示帮助信息。
• ArgDefaultValue: 指定参数的默认值。
• ArgIgnore: 忽略该参数。
• StickyArg: 使用上次使用的值（如果未指定）。

以下是一个简单的示例，演示如何使用 PowerArgs 解析命令行参数：

public class MyArgs
{
    [ArgRequired(PromptIfMissing=true)]
    public string StringArg { get; set; }

    [ArgRange(0,60)]
    public int IntArg { get; set; }
}

class Program
{
    static void Main(string[] args)
    {
        try
        {
            var parsed = Args.Parse<MyArgs>(args);
            Console.WriteLine("您输入的字符串为 '{0}'，整数为 '{1}'", parsed.StringArg, parsed.IntArg);
        }
        catch (ArgException ex)
        {
            Console.WriteLine(ex.Message);
            Console.WriteLine(ArgUsage.GenerateUsageFromTemplate<MyArgs>());
        }
    }
}

4. 项目安装方式

PowerArgs 可以通过 NuGet 包管理器安装到您的 .NET 项目中。在 Visual Studio 中，您可以通过以下方式安装：

1. 在解决方案资源管理器中，右键点击您的项目。
2. 选择“管理 NuGet 包”。
3. 在 NuGet 包管理器界面中，搜索“PowerArgs”。
4. 选择 PowerArgs 包并安装。

安装完成后，您就可以在项目中使用 PowerArgs 来处理命令行参数了。