SuperAPI AI 工具集

dotnet-best-practices

通用与其它

查看项目

更新于 10-15 21:52

技能介绍

用途:确保 ${selection} 中的 .NET/C# 代码符合该解决方案/项目特定的最佳实践,属于代码规范检查类技能。

主要能力:覆盖多个方面。文档与结构上,要求为公共类、接口、方法和属性编写完整 XML 文档注释,包含参数与返回值说明,并遵循 {Core|Console|App|Service}.{Feature} 命名空间结构。设计模式与架构上,使用主构造函数语法做依赖注入,实现带泛型基类的 Command Handler 模式,接口以 I 前缀命名并遵循接口隔离,复杂对象创建使用工厂模式。依赖注入与服务上,使用构造函数注入并通过 ArgumentNullException 做空检查,按 Singleton、Scoped、Transient 注册服务,使用 Microsoft.Extensions.DependencyInjection,为可测试性实现服务接口。资源与本地化上,使用 ResourceManager,分离 LogMessages 与 ErrorMessages 资源文件,通过 _resourceManager.GetString("MessageKey") 访问。异步上,所有 I/O 与长任务使用 async/await,返回 Task 或 Task<T>,适当使用 ConfigureAwait(false) 并正确处理异常。测试上,使用 MSTest 配合 FluentAssertions,遵循 AAA 模式,用 Moq 模拟依赖,覆盖成功与失败场景及空参数校验。配置上,使用强类型配置类与数据注解,实现 Required、NotEmptyOrWhitespace 等校验,使用 IConfiguration 绑定并支持 appsettings.json。AI 集成上,使用 Microsoft.SemanticKernel,正确配置内核与服务注册,处理 ChatCompletion、Embedding 等模型设置,采用结构化输出。错误处理与日志上,使用 Microsoft.Extensions.Logging 结构化日志,带作用域上下文,抛出具体异常,对预期失败使用 try-catch。性能与安全上,使用 C# 12+ 与 .NET 8 优化,做输入校验与清理,数据库使用参数化查询,AI/ML 遵循安全编码。代码质量上,遵循 SOLID,通过基类与工具类避免重复,命名体现领域概念,方法聚焦内聚,正确实现资源释放。

使用方式:资料未提供具体安装命令或调用步骤,仅说明任务是对 ${selection} 中的代码执行上述检查。

适用场景:.NET/C# 解决方案或项目的代码审查与规范落地。

限制:资料未提供收费、价格、平台支持范围及效果保证等信息。