UI组件跨平台桌面应用【免费下载链接】Terminal.GuiCross Platform Terminal UI toolkit for .NET项目地址https://gitcode.com/gh_mirrors/te/Terminal.Gui点击查看免费下载本篇技术指南聚焦于 Terminal.Gui.NET 跨平台终端 UI 工具包在长期多开发者协作中沉淀出的 C# 代码布局规范核心解决一个具体而高频的问题属性Property与后备字段Backing Field必须相邻摆放。阅读本文后你将掌握 Terminal.Gui 的成员排序顺序、后备字段命名的下划线约定理解为何不能依赖 ReSharper 等自动化工具完成这一布局并能借助仓库中自研的 Roslyn 工具BackingFieldReorderer批量修正代码布局。一、规范背景为什么后备字段必须紧跟属性在 C# 中属性常常由一个私有字段承载其值这个字段即后备字段backing field。Terminal.Gui 项目要求在源码中后备字段必须直接置于其对应属性的上方二者之间不穿插其他成员。正确写法如下摘自 .claude/rules/code-layout.md 的规则原文// CORRECT - backing field directly above its property private string _name; public string Name { get _name; set _name value; } private int _count; public int Count { get _count; set _count value; }而下面这种把所有后备字段集中堆在类首、与属性分离的写法是被明确禁止的// WRONG - all backing fields grouped together, separate from properties private string _name; private int _count; public string Name { get _name; set _name value; } public int Count { get _count; set _count value; }这一规则并非 Terminal.Gui 独有而是团队在代码审查与合并实践中总结出的可读性要求后备字段与属性相邻读者无需在文件内来回跳转即可确认属性的存储语义、默认值初始化与访问器逻辑diff 与代码审查的上下文也更聚焦。该规范同时被写入了 AGENTS.md 的Quick Rules第 7 条Backing fields - Place immediately before their property作为所有 AI Agent 与人类贡献者修改代码前的强制检查项与禁止var滥用使用new ()目标类型推断集合表达式[...]等约定并列。二、为何不能依赖 ReSharper 自动布局code-layout.md中特别指出ReSharper 的 Properties w/ Backing Field 文件布局功能存在缺陷对应 JetBrains YouTrack 问题号 RSRP-484963它无法自动将后备字段与所属属性归组即使项目启用了该项布局规则运行 Reorder Type Members 后字段仍会被拆散。这一论断在仓库的 Terminal.sln.DotSettings 中可以得到印证该文件确实配置了Properties w/ Backing Field的布局模式CSharpFileLayoutPatterns/Pattern中定义了PropertyPart MatchField与PropertyPart MatchProperty两个归组条目同时设置了PlaceBackingFieldAboveProperty为True。然而规则明确指出——配置存在不意味着功能可靠不要依赖 ReSharper 的 Reorder Type Members 来摆放后备字段不要依赖任何自动化工具来为属性分组后备字段。因此这个把字段放到属性正上方的动作被定义为AI Agent 的显式职责无论由人类还是 AI 编写、重组代码都必须手工保证字段紧邻属性。这正是该文档以AI Agent Responsibility开宗明义的原因——在 AI 辅助编码日益普遍的今天自动补全与重构工具生成的后备字段位置必须经过人工/代理二次校验。三、类型内成员排序总纲除后备字段与属性的相邻关系外code-layout.md还定义了类型type内部的整体成员顺序常量与静态字段Constants and static fields构造函数Constructors属性及其后备字段Properties with their backing fields字段紧跟属性之前其他实例字段Other instance fields非后备字段接口实现Interface implementations其他成员Other members方法等嵌套类型Nested types这套顺序与 Terminal.sln.DotSettings 中 ReSharper 的默认布局模式基本一致该模式依次定义了 Public Delegates/Enums、Static Fields and Constants、Constructors、Fields、Properties w/ Backing Field、Interface Implementations、All other members、Nested Types。注意两者间的细微差异项目规则把常量与静态字段合并为第一组、将接口实现提前到普通方法之前这与Terminal.sln.DotSettings中的配置顺序是吻合的即 ReSharper 布局模板本身即按此设计——唯一的例外是后备字段归组这一环节因工具缺陷而失效需要手工保障。排序遵循从静态到实例、从数据到行为、从外部契约到内部实现的阅读直觉常量/静态字段先出现因为它们通常承载类型级的不变数据构造函数紧随其后读者先看到对象如何被创建属性块集中展示对外可访问的状态普通实例字段放在属性之后作为内部实现细节接口实现单独成组便于快速判断类型实现了哪些契约方法等其他成员收尾嵌套类型永远放在最后。四、仓库中的真实样板View.Content.cs在 Terminal.Gui 的核心类型View中这套规则被严格执行。以 Terminal.Gui/ViewBase/View.Content.cs 为例// Nullable holders of developer-specified content dimensions. // When null the corresponding dimension tracks the Viewport size automatically. private int? _contentWidth; private int? _contentHeight; /// summary /// Sets the width of the Views content area independently of the height. /// /summary public void SetContentWidth (int? contentWidth) { ... }这里_contentWidth、_contentHeight两个实例字段紧邻其上的文档注释与使用它们的SetContentWidth/SetContentHeight方法字段名采用下划线前缀 小驼峰camelCase命名。该文件的 ViewportSettings 属性 更是后备字段与属性相邻的典型案例ViewportSettingsFlags属性通过field关键字直接访问后备字段setter 内部读取field进行变更比较字段与属性的强关联一目了然。五、工具链支持BackingFieldReorderer 与配套脚本由于规则明确不得依赖自动化工具完成归组Terminal.Gui 索性自研了基于 Roslyn 的代码重排工具作为代码清理流水线中的一个辅助步骤弥补 ReSharper 的缺陷。5.1 BackingFieldReorderer 的实现原理工具源码位于 Scripts/BackingFieldReorderer/Program.cs核心是一个继承CSharpSyntaxRewriter的BackingFieldReordererRewriter其算法可概括为三步建映射遍历类的全部成员凡是以_开头且长度大于 1 的字段即被认定为潜在后备字段并通过命名约定推导对应属性名——首字母大写后与属性名匹配_name→Name跳过字段若某字段确实存在同名属性构成后备字段对则在主循环中先跳过它不立即输出属性前插入当遇到拥有后备字段的属性时先将该后备字段写入输出列表再写入属性本身。关键代码如下节选自 Program.cs// Check if this is a backing field (starts with _) if (fieldName.StartsWith (_) fieldName.Length 1) { // Potential backing field: _fieldName - FieldName string potentialPropertyName char.ToUpper (fieldName [1]) fieldName [2..]; backingFieldMap [potentialPropertyName] field; }工具以命令行方式使用接受一个.cs文件路径作为参数原地重写文件BackingFieldReorderer file.cs若未提供参数或文件不存在会输出Usage: BackingFieldReorderer file.cs或File not found: ...并以非零退出码返回成功后打印✓ Reordered backing fields in 文件名。项目文件 Scripts/BackingFieldReorderer/BackingFieldReorderer.csproj 表明其基于 .NET 8net8.0与Microsoft.CodeAnalysis.CSharp构建。5.2 清理流水线中的位置Scripts/CleanupAgent.ps1 将后备字段重排作为代码清理步骤 3固化进自动化流程文件先经 ReSharper cleanup步骤 2整理格式随后立即调用Invoke-BackingFieldReorder步骤 3修复后备字段位置再依次处理#nullable enable指令步骤 4与 CWP TODO 注释步骤 5。其中Invoke-BackingFieldReorder函数直接调用编译产物Scripts\BackingFieldReorderer\bin\Debug\net8.0\BackingFieldReorderer.exe。5.3 其他工具的一致处理Scripts/PartialSplitter/Program.cs 在拆分大型 partial 文件时也专门实现了第二遍处理BuildBackingFieldMap 将后备字段加入所属属性所在的成员分组确保拆分后每个 partial 文件内部依然满足字段紧跟属性的布局约定从工具层面维护了规范的一致性。5.4 运行与验证本地复现该工具链的方式如下仓库只读仅涉及查看与构建# 构建重排工具 dotnet build Scripts/BackingFieldReorderer/BackingFieldReorderer.csproj # 对单个文件执行重排 dotnet run --project Scripts/BackingFieldReorderer -- path/to/SomeFile.cs重排前后可通过git diff验证仅发生成员顺序变化CleanupAgent.ps1还会对比清理前后的构建警告与 ReSharper InspectCode 警告数量确保不引入新警告的硬性门槛。六、给贡献者与 AI Agent 的操作清单综合规则文档与仓库实践在 Terminal.Gui 中写代码时请遵守以下检查清单命名私有后备字段统一使用_camelCase下划线前缀由 Terminal.sln.DotSettings 的命名规则强制约束相邻任何带后备字段的属性字段必须紧贴其上二者之间不得有别的成员不要手写 setter 样板若属性仅做存储转发优先使用自动属性或field关键字见 View.Content.cs 的ViewportSettings写法排序按常量/静态字段 → 构造函数 → 属性后备字段 → 其他实例字段 → 接口实现 → 其他成员 → 嵌套类型组织类型成员不信任工具ReSharper 的 Reorder Type Members 会拆散字段与属性运行任何格式化/清理操作后必须人工复核后备字段位置必要时用BackingFieldReorderer修复。七、小结Terminal.Gui 的代码布局规范以可读性与可审查性为第一原则后备字段紧邻属性让状态与行为在视觉上成对出现类型成员的分组排序让任何规模的类都能被快速导航。而对 ReSharper 缺陷的清醒认知——配置存在 ≠ 功能可靠——促使项目既在.DotSettings中保留布局模式又以BackingFieldReorderer这样的 Roslyn 工具在 CI/清理脚本中兜底同时始终把人工/Agent 显式负责作为最终保障。这套规范 工具 人工复核的组合对任何追求代码布局一致性的 .NET 团队都具借鉴价值。赞分享UI组件跨平台桌面应用【免费下载链接】Terminal.GuiCross Platform Terminal UI toolkit for .NET项目地址https://gitcode.com/gh_mirrors/te/Terminal.Gui点击查看免费下载相关推荐10分钟上手dosemu2新手必备的配置技巧与常见问题解决10分钟上手dosemu2新手必备的配置技巧与常见问题解决 dosemu2是一款能够在Linux系统下运行DOS程序的工具它为用户提供了在现代操作系统中体验PowerShell最佳实践与风格指南代码布局与格式化规范PowerShell最佳实践与风格指南代码布局与格式化规范 前言 在PowerShell脚本开发中良好的代码布局与格式化习惯不仅能提升代码的可读性还能显著C代码规范终极指南Core Guidelines命名与布局最佳实践C代码规范终极指南Core Guidelines命名与布局最佳实践 在C开发中统一的代码风格是提升项目可维护性的关键因素。C Core Guid文档教程创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Terminal.Gui 代码布局规范：Backing Field 与成员排序的工程实践指南
UI组件跨平台桌面应用【免费下载链接】Terminal.GuiCross Platform Terminal UI toolkit for .NET项目地址https://gitcode.com/gh_mirrors/te/Terminal.Gui点击查看免费下载本篇技术指南聚焦于 Terminal.Gui.NET 跨平台终端 UI 工具包在长期多开发者协作中沉淀出的 C# 代码布局规范核心解决一个具体而高频的问题属性Property与后备字段Backing Field必须相邻摆放。阅读本文后你将掌握 Terminal.Gui 的成员排序顺序、后备字段命名的下划线约定理解为何不能依赖 ReSharper 等自动化工具完成这一布局并能借助仓库中自研的 Roslyn 工具BackingFieldReorderer批量修正代码布局。一、规范背景为什么后备字段必须紧跟属性在 C# 中属性常常由一个私有字段承载其值这个字段即后备字段backing field。Terminal.Gui 项目要求在源码中后备字段必须直接置于其对应属性的上方二者之间不穿插其他成员。正确写法如下摘自 .claude/rules/code-layout.md 的规则原文// CORRECT - backing field directly above its property private string _name; public string Name { get _name; set _name value; } private int _count; public int Count { get _count; set _count value; }而下面这种把所有后备字段集中堆在类首、与属性分离的写法是被明确禁止的// WRONG - all backing fields grouped together, separate from properties private string _name; private int _count; public string Name { get _name; set _name value; } public int Count { get _count; set _count value; }这一规则并非 Terminal.Gui 独有而是团队在代码审查与合并实践中总结出的可读性要求后备字段与属性相邻读者无需在文件内来回跳转即可确认属性的存储语义、默认值初始化与访问器逻辑diff 与代码审查的上下文也更聚焦。该规范同时被写入了 AGENTS.md 的Quick Rules第 7 条Backing fields - Place immediately before their property作为所有 AI Agent 与人类贡献者修改代码前的强制检查项与禁止var滥用使用new ()目标类型推断集合表达式[...]等约定并列。二、为何不能依赖 ReSharper 自动布局code-layout.md中特别指出ReSharper 的 Properties w/ Backing Field 文件布局功能存在缺陷对应 JetBrains YouTrack 问题号 RSRP-484963它无法自动将后备字段与所属属性归组即使项目启用了该项布局规则运行 Reorder Type Members 后字段仍会被拆散。这一论断在仓库的 Terminal.sln.DotSettings 中可以得到印证该文件确实配置了Properties w/ Backing Field的布局模式CSharpFileLayoutPatterns/Pattern中定义了PropertyPart MatchField与PropertyPart MatchProperty两个归组条目同时设置了PlaceBackingFieldAboveProperty为True。然而规则明确指出——配置存在不意味着功能可靠不要依赖 ReSharper 的 Reorder Type Members 来摆放后备字段不要依赖任何自动化工具来为属性分组后备字段。因此这个把字段放到属性正上方的动作被定义为AI Agent 的显式职责无论由人类还是 AI 编写、重组代码都必须手工保证字段紧邻属性。这正是该文档以AI Agent Responsibility开宗明义的原因——在 AI 辅助编码日益普遍的今天自动补全与重构工具生成的后备字段位置必须经过人工/代理二次校验。三、类型内成员排序总纲除后备字段与属性的相邻关系外code-layout.md还定义了类型type内部的整体成员顺序常量与静态字段Constants and static fields构造函数Constructors属性及其后备字段Properties with their backing fields字段紧跟属性之前其他实例字段Other instance fields非后备字段接口实现Interface implementations其他成员Other members方法等嵌套类型Nested types这套顺序与 Terminal.sln.DotSettings 中 ReSharper 的默认布局模式基本一致该模式依次定义了 Public Delegates/Enums、Static Fields and Constants、Constructors、Fields、Properties w/ Backing Field、Interface Implementations、All other members、Nested Types。注意两者间的细微差异项目规则把常量与静态字段合并为第一组、将接口实现提前到普通方法之前这与Terminal.sln.DotSettings中的配置顺序是吻合的即 ReSharper 布局模板本身即按此设计——唯一的例外是后备字段归组这一环节因工具缺陷而失效需要手工保障。排序遵循从静态到实例、从数据到行为、从外部契约到内部实现的阅读直觉常量/静态字段先出现因为它们通常承载类型级的不变数据构造函数紧随其后读者先看到对象如何被创建属性块集中展示对外可访问的状态普通实例字段放在属性之后作为内部实现细节接口实现单独成组便于快速判断类型实现了哪些契约方法等其他成员收尾嵌套类型永远放在最后。四、仓库中的真实样板View.Content.cs在 Terminal.Gui 的核心类型View中这套规则被严格执行。以 Terminal.Gui/ViewBase/View.Content.cs 为例// Nullable holders of developer-specified content dimensions. // When null the corresponding dimension tracks the Viewport size automatically. private int? _contentWidth; private int? _contentHeight; /// summary /// Sets the width of the Views content area independently of the height. /// /summary public void SetContentWidth (int? contentWidth) { ... }这里_contentWidth、_contentHeight两个实例字段紧邻其上的文档注释与使用它们的SetContentWidth/SetContentHeight方法字段名采用下划线前缀 小驼峰camelCase命名。该文件的 ViewportSettings 属性 更是后备字段与属性相邻的典型案例ViewportSettingsFlags属性通过field关键字直接访问后备字段setter 内部读取field进行变更比较字段与属性的强关联一目了然。五、工具链支持BackingFieldReorderer 与配套脚本由于规则明确不得依赖自动化工具完成归组Terminal.Gui 索性自研了基于 Roslyn 的代码重排工具作为代码清理流水线中的一个辅助步骤弥补 ReSharper 的缺陷。5.1 BackingFieldReorderer 的实现原理工具源码位于 Scripts/BackingFieldReorderer/Program.cs核心是一个继承CSharpSyntaxRewriter的BackingFieldReordererRewriter其算法可概括为三步建映射遍历类的全部成员凡是以_开头且长度大于 1 的字段即被认定为潜在后备字段并通过命名约定推导对应属性名——首字母大写后与属性名匹配_name→Name跳过字段若某字段确实存在同名属性构成后备字段对则在主循环中先跳过它不立即输出属性前插入当遇到拥有后备字段的属性时先将该后备字段写入输出列表再写入属性本身。关键代码如下节选自 Program.cs// Check if this is a backing field (starts with _) if (fieldName.StartsWith (_) fieldName.Length 1) { // Potential backing field: _fieldName - FieldName string potentialPropertyName char.ToUpper (fieldName [1]) fieldName [2..]; backingFieldMap [potentialPropertyName] field; }工具以命令行方式使用接受一个.cs文件路径作为参数原地重写文件BackingFieldReorderer file.cs若未提供参数或文件不存在会输出Usage: BackingFieldReorderer file.cs或File not found: ...并以非零退出码返回成功后打印✓ Reordered backing fields in 文件名。项目文件 Scripts/BackingFieldReorderer/BackingFieldReorderer.csproj 表明其基于 .NET 8net8.0与Microsoft.CodeAnalysis.CSharp构建。5.2 清理流水线中的位置Scripts/CleanupAgent.ps1 将后备字段重排作为代码清理步骤 3固化进自动化流程文件先经 ReSharper cleanup步骤 2整理格式随后立即调用Invoke-BackingFieldReorder步骤 3修复后备字段位置再依次处理#nullable enable指令步骤 4与 CWP TODO 注释步骤 5。其中Invoke-BackingFieldReorder函数直接调用编译产物Scripts\BackingFieldReorderer\bin\Debug\net8.0\BackingFieldReorderer.exe。5.3 其他工具的一致处理Scripts/PartialSplitter/Program.cs 在拆分大型 partial 文件时也专门实现了第二遍处理BuildBackingFieldMap 将后备字段加入所属属性所在的成员分组确保拆分后每个 partial 文件内部依然满足字段紧跟属性的布局约定从工具层面维护了规范的一致性。5.4 运行与验证本地复现该工具链的方式如下仓库只读仅涉及查看与构建# 构建重排工具 dotnet build Scripts/BackingFieldReorderer/BackingFieldReorderer.csproj # 对单个文件执行重排 dotnet run --project Scripts/BackingFieldReorderer -- path/to/SomeFile.cs重排前后可通过git diff验证仅发生成员顺序变化CleanupAgent.ps1还会对比清理前后的构建警告与 ReSharper InspectCode 警告数量确保不引入新警告的硬性门槛。六、给贡献者与 AI Agent 的操作清单综合规则文档与仓库实践在 Terminal.Gui 中写代码时请遵守以下检查清单命名私有后备字段统一使用_camelCase下划线前缀由 Terminal.sln.DotSettings 的命名规则强制约束相邻任何带后备字段的属性字段必须紧贴其上二者之间不得有别的成员不要手写 setter 样板若属性仅做存储转发优先使用自动属性或field关键字见 View.Content.cs 的ViewportSettings写法排序按常量/静态字段 → 构造函数 → 属性后备字段 → 其他实例字段 → 接口实现 → 其他成员 → 嵌套类型组织类型成员不信任工具ReSharper 的 Reorder Type Members 会拆散字段与属性运行任何格式化/清理操作后必须人工复核后备字段位置必要时用BackingFieldReorderer修复。七、小结Terminal.Gui 的代码布局规范以可读性与可审查性为第一原则后备字段紧邻属性让状态与行为在视觉上成对出现类型成员的分组排序让任何规模的类都能被快速导航。而对 ReSharper 缺陷的清醒认知——配置存在 ≠ 功能可靠——促使项目既在.DotSettings中保留布局模式又以BackingFieldReorderer这样的 Roslyn 工具在 CI/清理脚本中兜底同时始终把人工/Agent 显式负责作为最终保障。这套规范 工具 人工复核的组合对任何追求代码布局一致性的 .NET 团队都具借鉴价值。赞分享UI组件跨平台桌面应用【免费下载链接】Terminal.GuiCross Platform Terminal UI toolkit for .NET项目地址https://gitcode.com/gh_mirrors/te/Terminal.Gui点击查看免费下载相关推荐10分钟上手dosemu2新手必备的配置技巧与常见问题解决10分钟上手dosemu2新手必备的配置技巧与常见问题解决 dosemu2是一款能够在Linux系统下运行DOS程序的工具它为用户提供了在现代操作系统中体验PowerShell最佳实践与风格指南代码布局与格式化规范PowerShell最佳实践与风格指南代码布局与格式化规范 前言 在PowerShell脚本开发中良好的代码布局与格式化习惯不仅能提升代码的可读性还能显著C代码规范终极指南Core Guidelines命名与布局最佳实践C代码规范终极指南Core Guidelines命名与布局最佳实践 在C开发中统一的代码风格是提升项目可维护性的关键因素。C Core Guid文档教程创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考