Godot 引擎 C 脚本诊断规则全解:从 Godot.SourceGenerators 的 AnalyzerReleases.Shipped.md 读懂 GD 系列报错

Godot 引擎 C 脚本诊断规则全解:从 Godot.SourceGenerators 的 AnalyzerReleases.Shipped.md 读懂 GD 系列报错 Godot 引擎 C# 脚本诊断规则全解从 Godot.SourceGenerators 的 AnalyzerReleases.Shipped.md 读懂 GD 系列报错【免费下载链接】godotGodot Engine – Multi-platform 2D and 3D game engine项目地址: https://gitcode.com/GitHub_Trending/go/godot本文以 AnalyzerReleases.Shipped.md 这一 Roslyn 分析器发布追踪Release Tracking清单文件为核心骨架完整梳理 Godot 4.x C# 支持Mono 模块中Godot.SourceGenerators组件自 4.0 至 4.4 各版本引入的全部 GD 系列诊断规则。读完本文你将掌握三类能力一、看懂每个 GD 报错 IDGD0001–GD0402的触发场景与修复方式二、理解 Shipped/Unshipped 双清单文件在 Roslyn 分析器工程化中的定位与 csproj 集成方式三、顺着文档中的每条规则定位到仓库中对应的规则定义、报告点与测试用例完成源码级验证。一、AnalyzerReleases.Shipped.md 是什么Roslyn 分析器的发布追踪清单AnalyzerReleases.Shipped.md是 .NET 编译器平台Roslyn生态中分析器/代码修复工具的标准约定文件之一。配套还有AnalyzerReleases.Unshipped.md当前仓库中该文件为空见 AnalyzerReleases.Unshipped.md。二者的分工是Shipped 清单记录已经随某个版本发布的所有诊断规则按 Release 版本分节每节下用表格列出规则 ID、类别Category、严重级别Severity与备注Unshipped 清单记录尚未发布的新规则规则正式发版后从 Unshipped 迁移到 Shipped 的对应版本节中。在 Godot.SourceGenerators.csproj 中这两个文件通过AdditionalFiles项被显式纳入构建!-- Analyzer release tracking -- ItemGroup AdditionalFiles IncludeAnalyzerReleases.Shipped.md / AdditionalFiles IncludeAnalyzerReleases.Unshipped.md / /ItemGroup同一段 csproj 还体现了 Godot 对该工具链的工程化约束项目以netstandard2.0为目标框架、LangVersion10开启EnforceExtendedAnalyzerRules对分析器扩展规则强制执行依赖Microsoft.CodeAnalysis.CSharp.Workspaces 3.11.0并在打包时把生成的 DLL 放入 NuGet 包的analyzers/dotnet/cs目录——这意味着该程序集以分析器/生成器身份注入用户的 C# 编译过程而非作为普通类库被引用IncludeBuildOutput被设为false以印证此点。当前仓库中该包版本为4.8.0而 Shipped 清单记录到的最新规则批次为 Release 4.4说明 4.5 之后暂未新增对外可见的诊断规则。二、Shipped 清单完整内容四个版本的 GD 规则发布史下面完整继承原文档的四节 Release 表格原表中每条规则均附有指向 Godot 官方文档站对应诊断页的 Documentation 链接此处按规范不再列出外部 URL可按规则 ID 在 Godot 官方文档的 C# 诊断章节检索Release 4.0GD0001–GD0002、GD0101–GD0106、GD0201–GD0203、GD0301–GD0303共 14 条Rule IDCategorySeverityNotesGD0001UsageErrorScriptPathAttributeGeneratorGD0002UsageErrorScriptPathAttributeGeneratorGD0101UsageErrorScriptPropertyDefValGeneratorGD0102UsageErrorScriptPropertyDefValGeneratorGD0103UsageErrorScriptPropertiesGeneratorGD0104UsageErrorScriptPropertiesGeneratorGD0105UsageErrorScriptPropertyDefValGeneratorGD0106UsageErrorScriptPropertyDefValGeneratorGD0201UsageErrorScriptSignalsGeneratorGD0202UsageErrorScriptSignalsGeneratorGD0203UsageErrorScriptSignalsGeneratorGD0301UsageErrorMustBeVariantAnalyzerGD0302UsageErrorMustBeVariantAnalyzerGD0303UsageErrorMustBeVariantAnalyzerRelease 4.22 条Rule IDCategorySeverityNotesGD0107UsageErrorScriptPropertyDefValGeneratorGD0401UsageErrorGlobalClassAnalyzerGD0402UsageErrorGlobalClassAnalyzerRelease 4.31 条Rule IDCategorySeverityNotesGD0003UsageErrorScriptPathAttributeGeneratorRelease 4.44 条Rule IDCategorySeverityNotesGD0108UsageErrorScriptPropertiesGeneratorGD0109UsageErrorScriptPropertiesGeneratorGD0110UsageErrorScriptPropertiesGeneratorGD0111UsageErrorScriptPropertiesGenerator从四个版本节的演进可以看出 Godot C# 诊断规则的增长轨迹4.0 建立覆盖类声明、导出成员、信号、泛型 Variant的基础规则集4.2 补充 Node 导出约束与[GlobalClass]全局类约束4.3 收紧脚本文件内类名唯一性4.4 一次性加入 4 条[ExportToolButton]工具按钮相关规则。全部 23 条规则的 Category 均为Usage、Severity 均为Error且默认启用——即这些不是风格建议而是直接阻断编译的硬性约束。三、23 条规则的语义全景结合 Common.cs 的权威定义Shipped 表格只有 ID 与归属而每条规则的标题、消息模板与修复建议在源码中统一定义于 Common.cs。该文件为每个规则构造一个DiagnosticDescriptor且helpLinkUri由统一模板拼接Common.cs第 8 行private static readonly string _helpLinkFormat ${VersionDocsUrl}/tutorials/scripting/c_sharp/diagnostics/{{0}}.html;这正是 Shipped 表格中 Documentation 列链接的来源——诊断报错时 IDE 中的帮助链接与文档站页面一一对应。所有规则均设置isEnabledByDefault: true。按 ID 前缀分组后各规则的完整语义如下3.1 GD0001–GD0003脚本类声明规则partial 与类名唯一性ID规则标题修复建议源码 description 原文要点GD0001派生自 GodotObject 的类型缺少 partial 修饰符继承GodotObject的类必须声明为partialGD0002包含 GodotObject 派生嵌套类的外部类缺少 partial 修饰符派生类及其所有包含类型都必须加partialGD0003同一脚本文件中存在同名的多个类一个脚本文件只能有一个类名与文件名匹配从源码看GD0001/GD0002 由 ClassPartialModifierAnalyzer.cs 报告分析器注册SyntaxKind.ClassDeclaration语法节点动作先通过InheritsFrom(GodotSharp, GodotClasses.GodotObject)判定基类再检查IsPartial()对嵌套场景则沿父类链逐层检查。该文件还附带一个ClassPartialModifierCodeFixProvider代码修复第 62–111 行能在 IDE 中一键Add partial modifier。而 GD0003 则直接报告于 ScriptPathAttributeGenerator.cs正确路径为 ScriptPathAttributeGenerator.cs 第 101 行——这也是 Shipped 表格 Notes 列将 GD0001/GD0002 标注在ScriptPathAttributeGenerator名下4.0 版本时的归属记录的由来。为什么强制partial因为 Godot 的 C# 脚本采用源生成器 partial 类架构生成器需要往用户类中追加部分定义属性包装、序列化钩子、信号绑定等只有partial类才能被合并这正是 Godot C# 脚本区别于普通 C# 类的根本约束。3.2 GD0101–GD0111导出成员[Export]与工具按钮规则这一组共 11 条是清单中最大的一族覆盖[Export]属性与 4.4 新增的[ExportToolButton]特性ID触发场景修复建议要点GD0101导出成员是static只有实例字段/属性可导出去掉static或[Export]GD0102导出成员类型不受支持改用受支持的类型或去掉[Export]GD0103导出成员只读导出成员必须可写GD0104导出属性只写write-only导出属性必须可读GD0105导出成员是索引器indexer去掉[Export]GD0106导出属性是显式接口实现去掉[Export]GD0107非 Node 派生类型导出了 Node 成员Node 导出仅支持 Node 派生类4.2 新增GD0108[ExportToolButton]用在了非 Tool 类上加[Tool]特性或去掉[ExportToolButton]GD0109[ExportToolButton]与其他[Export]同时使用二者互斥保留其一GD0110工具按钮成员不是Callable类型[ExportToolButton]仅支持Callable类型成员GD0111工具按钮不是表达式体属性必须是形如new Callable(...)或Callable.From(...)的表达式体属性关于 Notes 列的归属需要一点源码级澄清Shipped 表格将 GD0103/GD0104 记在ScriptPropertiesGenerator名下而从源码结构看GD0101–GD0107 的报告点集中在 ScriptPropertyDefValGenerator.cs其中 GD0104 同时也在 ScriptPropertiesGenerator.cs 第 463 行有报告点GD0108–GD0111 则报告于ScriptPropertiesGenerator.cs第 286、440、475、570 行。两个生成器同属一个源生成器程序、职责不同ScriptPropertyDefValGenerator负责导出字段的默认值与合法性校验ScriptPropertiesGenerator负责属性导出包装与工具按钮表格 Notes 列记录的是规则随哪个生成器首次发布。3.3 GD0201–GD0203信号[Signal]委托签名规则ID触发场景GD0201[Signal]委托名称未以EventHandler结尾GD0202信号委托签名中的参数类型不受支持GD0203信号委托签名未返回void三条均由 ScriptSignalsGenerator.cs 报告。这一组确立了 Godot 4.x C# 信号写法的基本契约信号以 C# 委托声明、名称必须带EventHandler后缀、参数与返回值必须符合 Variant 兼容约束。3.4 GD0301–GD0303泛型与 [MustBeVariant] 约束ID触发场景GD0301泛型实参不是 Variant 兼容类型GD0302泛型形参未标注[MustBeVariant]特性GD0303某个必须 Variant 兼容的类型实参的父符号未被处理源码注释说明这是引擎自身的问题应上报 bug三条由 MustBeVariantAnalyzer.cs 报告。值得注意的是 GD0303 的语义定位与其他规则不同——它面向的不是用户代码错误而是引擎内部检查兜底。3.5 GD0401–GD0402[GlobalClass] 全局类规则4.2 新增ID触发场景GD0401标注[GlobalClass]的类未派生自GodotObject或其派生类GD0402标注[GlobalClass]的类是泛型类由 GlobalClassAnalyzer.cs 报告约束全局类这一跨脚本复用机制全局类必须是 Godot 对象类型的非泛型具名类型。四、追踪机制如何闭环从清单到测试用例Shipped 清单的价值在于让对外发布的规则集合可审计。仓库中与该清单对应的验证设施非常完整测试工程Godot.SourceGenerators.Tests 用 Roslyn 的CSharpAnalyzerVerifier/CSharpSourceGeneratorVerifier见 CSharpAnalyzerVerifier.cs、CSharpSourceGeneratorVerifier.cs在编译期对每条规则做应报/不应报断言输入样本TestData/Sources/目录下按规则命名如ClassPartialModifier.GD0001.cs、Generic.GD0003.cs、SameName.GD0003.cs、GlobalClass.GD0401.cs、MustBeVariant.GD0302.cs等与 Shipped 表格中的规则 ID 一一对应期望输出TestData/GeneratedSources/保存各生成器针对样本应产出的生成代码快照如Bar_ScriptPath.generated.cs、ScriptBoilerplate_ScriptProperties.generated.cs构成对生成器行为的回归基线测试驱动类如 ExportDiagnosticsTests.cs、GlobalClassAnalyzerTests.cs、MustBeVariantAnalyzerTests.cs按规则族组织。从源码结构看整个工程形成了一条闭环Common.cs集中定义规则 → 各分析器/生成器报告规则 →AnalyzerReleases.Shipped.md记录发布轨迹 → Tests 目录用样本代码反向验证每一环。开发者若要新增一条 GD 规则规范做法是先写入 Unshipped 清单、发版时迁入 Shipped 的版本节并同时补齐TestData样本与测试断言。五、实操速查遇到 GD 报错时该看哪里在 IDE 中看到GDxxxx报错时Help link 直达该 ID 的官方诊断页链接格式由Common.cs第 8 行统一生成查触发条件与修复文案以规则 ID 为关键词检索 Common.csmessageFormat是编辑器里显示的原文description参数是官方修复建议查报告点与判定逻辑按 Shipped 表格 Notes 列找到对应生成器/分析器文件如 GD0107 看ScriptPropertyDefValGenerator.csGD0401 看GlobalClassAnalyzer.cs查行为回归在Godot.SourceGenerators.Tests/TestData/中找到同名样本文件对照 Sources 与 GeneratedSources 理解该规则在真实编译中的输入输出查版本引入时间回到本文第二部分对应的 Release 节确认该规则从哪个 Godot 版本开始生效——这在使用旧版 SDK 迁移项目时尤其有用。六、小结AnalyzerReleases.Shipped.md 看似只有一张规则表实则是 Godot C# 脚本工具链的对外契约总账它把 4.0 至 4.4 四个版本发布的 23 条 Error 级诊断规则按版本归档与 Common.cs 中的DiagnosticDescriptor定义、各分析器/生成器的报告点、以及Godot.SourceGenerators.Tests的完整测试基线相互咬合。理解这份清单就理解了 Godot 引擎如何在 C# 编译阶段前置拦截非 partial 的 Godot 类、非法导出成员、不合规信号委托、越界的泛型与全局类等一切会导致运行时注册失败的脚本错误。【免费下载链接】godotGodot Engine – Multi-platform 2D and 3D game engine项目地址: https://gitcode.com/GitHub_Trending/go/godot创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考