SuperAPI AI 工具集

dotnet-csharp-coding-standards

编程与开发

查看项目

更新于 10-16 02:33

技能介绍

用途:为规划、设计、生成、修改或审查 C#/.NET 代码的任务提供基线编码规范,应在实现开始前默认加载,无需等待用户明确提及“编码规范”。它是领域专用 C#/.NET 技能的前置依赖。

主要能力:命名约定(命名空间、类/记录/结构体用 PascalCase,接口加 I 前缀,私有字段用 _camelCase,参数与局部变量用 camelCase,异步方法加 Async 后缀,布尔值用 is/has/can 前缀,集合用复数名词);文件组织(每个顶层类型一个同名文件、使用文件作用域命名空间、using 指令置于命名空间外并按 System、第三方、项目顺序排列、按功能或分层组织目录);代码风格(控制流始终使用大括号、单表达式成员用表达式体、类型明显时用 var、优先模式匹配处理 null、优先字符串插值、显式声明访问修饰符、遵循修饰符顺序);类型设计(默认密封类、优先组合而非继承、接口隔离、CancellationToken 作为异步方法最后一个参数并向下传递、公共 API 添加简洁 XML 文档);通过 Directory.Build.props 与 .editorconfig 配置分析器强制执行。

使用方式:在生成或审查 C# 代码前加载本技能;配合 .editorconfig 规则(如 csharp_style_namespace_declarations = file_scoped:warning、csharp_prefer_braces = true:warning)与构建属性(EnforceCodeStyleInBuild、AnalysisLevel、TreatWarningsAsErrors)自动约束风格。

适用场景:任何涉及 C#/.NET 代码编写、评审与重构的智能体任务。

限制:不涵盖语言特性模式、异步命名与 await 约定、SOLID/DRY 设计原则、代码坏味与反模式,这些分别由其他技能处理。规范依据微软框架设计指南与 C# 语言设计说明等公开资料,不代表或代言上述来源。