C# Academy · 课时

开发者体验与局限

Q: 「开发者体验与局限」这节课中我会学到什么？

了解生成器如何影响开发者体验：命名、文件发现、诊断、构建性能和安全回退方案——包括 C# 6 模拟。 你通过在浏览器中直接运行的动手代码来练习 C# Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

了解生成器如何影响开发者体验：命名、文件发现、诊断、构建性能和安全回退方案——包括 C# 6 模拟。

开发者体验与局限 是 CoddyKit 上的免费 C# Academy 课时。这是第 2 节课，共 2 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 C# Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 C# Academy 课程共包含 2 节课。

开发者体验与限制概览

目标：让生成的代码易于使用。

可预测的名称和文件位置
有帮助的诊断信息
小巧、专注的输出内容
了解限制：仅在构建时运行，不进行运行时反射

可预测的名称

使用稳定的名称（例如 *.g.cs、DebugId），让用户可以快速找到生成的成员。

using System;

// Emulate "predictable" generated naming: suffixes and folders are consistent.
public partial class Order
{
  public int Id;
}

// Simulated generated piece: same partial name, with a clear suffix convention.
public partial class Order // would live in Order.g.cs typically
{
  public string DebugId()
  {
    // predictable member name makes discovery easy
    return "Order#" + Id;
  }
}

public class Program
{
  public static void Main(string[] args)
  {
    Order o = new Order();
    o.Id = 42;
    Console.WriteLine(o.DebugId());
  }
}

避免名称冲突

使用独立的命名空间（例如 Generated.*）和清晰的前缀，有助于避免与用户代码发生冲突。

using System;

namespace Generated
{
  // Emulate a generator using a dedicated namespace to reduce collisions
  public static class OrderExtensions
  {
    public static string ToLabel(this Order o) { return "Order: " + o.Id; }
  }
}

public partial class Order { public int Id; }

public class Program
{
  public static void Main(string[] args)
  {
    Order o = new Order();
    o.Id = 7;
    // Extension lives under Generated.* to stay out of the way
    Console.WriteLine(Generated.OrderExtensions.ToLabel(o));
  }
}

有帮助的诊断信息

当输入无效时，优秀的生成器会发出清晰的诊断信息，帮助用户快速修复代码。

using System;

// Emulate generator diagnostics: validate inputs and print clear messages.
public static class GenCheck
{
  public static string EmitGetter(string fieldName)
  {
    if (string.IsNullOrEmpty(fieldName))
      return "DIAGNOSTIC: Field name is empty. Skipping emission.";
    if (!char.IsLetter(fieldName[0]))
      return "DIAGNOSTIC: Field must start with a letter: " + fieldName;

    // pretend emission was fine
    return "OK: Generated getter for " + fieldName;
  }
}

public class Program
{
  public static void Main(string[] args)
  {
    Console.WriteLine(GenCheck.EmitGetter("1bad")); // diagnostic
    Console.WriteLine(GenCheck.EmitGetter("name")); // ok
  }
}

小巧且专注的输出

最好生成只承担一项职责的小型文件，这样更易于阅读和调试。

using System;

// Emulate small, single-purpose emissions instead of huge files.
public partial class Report
{
  public int Count;
}

public partial class Report // Report.Stats.g.cs idea
{
  public double Average(int total)
  {
    if (Count == 0) return 0.0;
    return (double)total / Count;
  }
}

public partial class Report // Report.Format.g.cs idea
{
  public string Summary(int total)
  {
    return "Total=" + total + ", Count=" + Count + ", Avg=" + Average(total);
  }
}

public class Program
{
  public static void Main(string[] args)
  {
    Report r = new Report();
    r.Count = 4;
    Console.WriteLine(r.Summary(20));
  }
}

限制与回退方案

限制：

在构建时运行，而不是运行时。
避免进行繁重的输入输出操作或网络调用。
不要依赖生成器路径中的运行时反射。
让输出保持确定性。

回退方案：如果输入无效，请发出诊断信息或生成最小存根，而不是让整个构建失败。

开发者体验最佳实践

快速检查：使用源代码生成器时，哪种做法可以改善开发者体验？

回顾

回顾：优先使用可预测的名称、清晰的诊断信息和小型输出。遵守构建时限制，并在输入无效时提供安全的回退方案。

常见问题解答

「开发者体验与局限」课时是免费的吗？

是的 — 「开发者体验与局限」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 C# Academy 课程的其余内容，请升级到 CoddyKit PRO。 C# Academy 课程共包含 2 节课。

「开发者体验与局限」这节课中我会学到什么？

了解生成器如何影响开发者体验：命名、文件发现、诊断、构建性能和安全回退方案——包括 C# 6 模拟。你通过在浏览器中直接运行的动手代码来练习 C# Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 C# Academy 需要有经验吗？

无需任何先前经验。CoddyKit 上的 C# Academy 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 2 节课，共 2 节。

「开发者体验与局限」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 C# Academy 课中编写并运行代码吗？

能。每节 C# Academy 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

概念与使用场景；增量生成器（概览）
开发者体验与局限

← 返回 C# Academy