添加 AI 提示词

Author: walterlv

docs/zh-hans/源生成器生成的源示例.md

@@ -0,0 +1,117 @@
+# 源生成器生成的源示例
+
+代码中的类型：
+
+```csharp
+internal record DotNet03_MixedOptions
+{
+    [Option]
+    public int Number { get; init; }
+
+    [Option]
+    public required string Text { get; init; }
+
+    [Option]
+    public bool Flag { get; init; }
+}
+```
+
+对应生成的源：
+
+```csharp
+#nullable enable
+namespace DotNetCampus.Cli.Tests;
+
+/// <summary>
+/// 辅助 <see cref="global::DotNetCampus.Cli.Tests.DotNet03_MixedOptions"/> 生成命令行选项、谓词或处理函数的创建。
+/// </summary>
+internal sealed class DotNet03_MixedOptionsBuilder
+{
+    public static object CreateInstance(global::DotNetCampus.Cli.CommandLine commandLine)
+    {
+        var caseSensitive = commandLine.DefaultCaseSensitive;
+        var result = new global::DotNetCampus.Cli.Tests.DotNet03_MixedOptions
+        {
+            Number = commandLine.GetOption("number") ?? default,
+            Text = commandLine.GetOption("text") ?? throw new global::DotNetCampus.Cli.Exceptions.RequiredPropertyNotAssignedException($"The command line arguments doesn't contain a required option '--text'. Command line: {commandLine}", "Text"),
+            Flag = commandLine.GetOption("flag") ?? default,
+            // There is no positional argument to be initialized.
+        };
+        // There is no option to be assigned.
+        // There is no positional argument to be assigned.
+        return result;
+    }
+}
+```
+
+代码中的方法调用：
+
+```csharp
+_ = CommandLine.Parse(args, CommandLineParsingOptions.DotNet).As<Options>();
+```
+
+对应生成的源（拦截器）：
+
+```csharp
+#nullable enable
+
+namespace DotNetCampus.CommandLine.Compiler
+{
+    file static class Interceptors
+    {
+        /// <summary>
+        /// <see cref="global::DotNetCampus.Cli.CommandLine.As{Options}()"/> 方法的拦截器。拦截以提高性能。
+        /// </summary>
+        [global::System.Runtime.CompilerServices.InterceptsLocation(1, /* Program.Run4xInterceptor @Program.cs */ "G4GJAK7udHFnPkRUqV6VzzgRAABQcm9ncmFtLmNz")]
+        [global::System.Runtime.CompilerServices.InterceptsLocation(1, /* Program.Run4xModule @Program.cs */ "G4GJAK7udHFnPkRUqV6VzxkSAABQcm9ncmFtLmNz")]
+        public static T CommandLine_As_DotNetCampusCliTestsFakesOptions<T>(this global::DotNetCampus.Cli.CommandLine commandLine)
+            where T : global::DotNetCampus.Cli.Tests.Fakes.Options
+        {
+            return (T)global::DotNetCampus.Cli.Tests.Fakes.OptionsBuilder.CreateInstance(commandLine);
+        }
+    }
+}
+
+namespace System.Runtime.CompilerServices
+{
+    [global::System.AttributeUsage(global::System.AttributeTargets.Method, AllowMultiple = true)]
+    file sealed class InterceptsLocationAttribute : global::System.Attribute
+    {
+        public InterceptsLocationAttribute(int version, string data)
+        {
+            _ = version;
+            _ = data;
+        }
+    }
+}
+```
+
+代码中的程序集命令处理器搜集：
+
+```csharp
+[CollectCommandHandlersFromThisAssembly]
+internal partial class AssemblyCommandHandler;
+```
+
+对应生成的源：
+
+```csharp
+#nullable enable
+namespace DotNetCampus.Cli.Tests.Fakes;
+
+/// <summary>
+/// 提供一种辅助自动搜集并执行本程序集中所有命令行处理器的方式。
+/// </summary>
+partial class AssemblyCommandHandler : global::DotNetCampus.Cli.Compiler.ICommandHandlerCollection
+{
+    public global::DotNetCampus.Cli.ICommandHandler? TryMatch(string? verb, global::DotNetCampus.Cli.CommandLine cl) => verb switch
+    {
+        null => throw new global::DotNetCampus.Cli.Exceptions.CommandVerbAmbiguityException($"Multiple command handlers match the same verb name 'null': AmbiguousOptions, CollectionOptions, ComparedOptions, DefaultVerbCommandHandler, DictionaryOptions, FakeCommandOptions, Options, PrimaryOptions, UnlimitedValueOptions, ValueOptions.", null),
+        // 类型 EditOptions 没有继承 ICommandHandler 接口，因此无法统一调度执行，只能由开发者单独调用。
+        "Fake" => (global::DotNetCampus.Cli.ICommandHandler)global::DotNetCampus.Cli.Tests.Fakes.FakeVerbCommandHandlerBuilder.CreateInstance(cl),
+        // 类型 PrintOptions 没有继承 ICommandHandler 接口，因此无法统一调度执行，只能由开发者单独调用。
+        // 类型 ShareOptions 没有继承 ICommandHandler 接口，因此无法统一调度执行，只能由开发者单独调用。
+        _ => null,
+    };
+}
+```