dotnet-best-practices
Ajuda seu agente a garantir que o código .NET/C# siga as melhores práticas. Ele verifica se o código está bem escrito e eficiente.
O que ela faz
Este agente de IA ajuda a garantir que seu código .NET/C# siga as melhores práticas recomendadas. Ele verifica a documentação, a estrutura, o uso de padrões de design, a injeção de dependência, o gerenciamento de recursos, o uso de async/await, os testes, a configuração, a integração com IA, o tratamento de erros, a segurança e a qualidade geral do código.
Quando usar
- ✓Ao escrever novo código C#.
- ✓Ao revisar código existente.
- ✓Ao otimizar o desempenho ou a segurança.
Exemplo do que pedir para a IA
“Verifique se este código C# segue as melhores práticas.”
Quer saber mais? Abra as seções abaixo.
Como usar
O jeito mais fácil: copie a mensagem abaixo e cole no Claude, ChatGPT, Cursor ou outra IA. Ela lê a skill e segue as instruções.
Link da skill
Mensagem pronta para colar
Como funciona
O agente analisa seu código em busca de padrões específicos, como documentação adequada, uso de padrões de design e tratamento correto de erros. Ele compara seu código com um conjunto de regras e sugere melhorias.
Instalação
Jeito mais fácil: copie o link da skill e cole no Claude, ChatGPT ou Cursor pedindo para seguir as instruções.
No terminal (Claude Code, Codex, Cursor), na pasta do projeto:
npx skills add github/awesome-copilot --skill dotnet-best-practicesOu baixe só o arquivo:
curl -L https://raw.githubusercontent.com/github/awesome-copilot/main/skills/dotnet-best-practices/SKILL.md -o SKILL.mdConteúdo técnico (SKILL.md)
Tradução do texto original do autor no GitHub. Os comandos e códigos estão como no original.
Melhores Práticas de .NET/C#
Sua tarefa é garantir que o código .NET/C# em ${selection} atenda às melhores práticas específicas desta solução/projeto. Isso inclui:
Documentação e Estrutura
- Crie comentários de documentação XML abrangentes para todas as classes públicas, interfaces, métodos e propriedades
- Inclua descrições de parâmetros e descrições de valores de retorno em comentários XML
- Siga a estrutura de namespace estabelecida: {Core|Console|App|Service}.{Feature}
Padrões de Design e Arquitetura
- Use a sintaxe de construtor primário para injeção de dependência (por exemplo,
public class MyClass(IDependency dependency)) - Implemente o padrão Command Handler com classes base genéricas (por exemplo,
CommandHandler<TOptions>) - Use segregação de interface com convenções de nomenclatura claras (prefixe interfaces com 'I')
- Siga o padrão Factory para criação de objetos complexos.
Injeção de Dependência e Serviços
- Use injeção de dependência por construtor com verificações de nulo via ArgumentNullException
- Registre serviços com tempos de vida apropriados (Singleton, Scoped, Transient)
- Use os padrões do Microsoft.Extensions.DependencyInjection
- Implemente interfaces de serviço para testabilidade
Gerenciamento de Recursos e Localização
- Use ResourceManager para mensagens localizadas e strings de erro
- Separe os arquivos de recursos LogMessages e ErrorMessages
- Acesse recursos via
_resourceManager.GetString("MessageKey")
Padrões Async/Await
- Use async/await para todas as operações de I/O e tarefas de longa duração
- Retorne Task ou Task<T> de métodos async
- Use ConfigureAwait(false) onde apropriado
- Trate exceções async corretamente
Padrões de Teste
- Use o framework MSTest com FluentAssertions para asserções
- Siga o padrão AAA (Arrange, Act, Assert)
- Use Moq para simular dependências
- Teste cenários de sucesso e falha
- Inclua testes de validação de parâmetro nulo
Configuração e Ajustes
- Use classes de configuração fortemente tipadas com anotações de dados
- Implemente atributos de validação (Required, NotEmptyOrWhitespace)
- Use a vinculação do IConfiguration para configurações
- Suporte aos arquivos de configuração appsettings.json
Integração Semantic Kernel e IA
- Use Microsoft.SemanticKernel para operações de IA
- Implemente configuração adequada do kernel e registro de serviço
- Gerencie configurações de modelo de IA (ChatCompletion, Embedding, etc.)
- Use padrões de saída estruturada para respostas de IA confiáveis
Tratamento de Erros e Logging
- Use logging estruturado com Microsoft.Extensions.Logging
- Inclua logging com escopo e contexto significativo
- Lance exceções específicas com mensagens descritivas
- Use blocos try-catch para cenários de falha esperados
Desempenho e Segurança
- Use recursos do C# 12+ e otimizações do .NET 8 onde aplicável
- Implemente validação e sanitização de entrada adequadas
- Use consultas parametrizadas para operações de banco de dados
- Siga práticas de codificação segura para operações de IA/ML
Qualidade do Código
- Garanta a conformidade com os princípios SOLID
- Evite duplicação de código através de classes base e utilitários
- Use nomes significativos que reflitam conceitos de domínio
- Mantenha métodos focados e coesos
- Implemente padrões de descarte adequados para recursos
Perguntas frequentes
O que são 'melhores práticas'?
São as formas mais eficientes e seguras de escrever código, que facilitam a manutenção e evitam erros comuns.
Preciso entender todos os termos técnicos para usar este agente?
Não, o agente foi projetado para ajudar mesmo que você não seja um programador experiente. Ele foca em aplicar regras que melhoram a qualidade do código.
O agente pode corrigir meu código automaticamente?
Este agente foca em identificar e sugerir melhorias. A correção automática pode depender de outras ferramentas ou de sua própria intervenção.
Detalhes
Descrição original do autor
Ensure .NET/C# code meets best practices for the solution/project.
repo: github/awesome-copilot
Popularidade
- Estrelas no GitHub
- 40 mil
- Posição no ranking
- #5120
- Licença
- MIT
- Atualizada em
- 15/10/2026
Comentários
- …
Mais skills deste repositório
acquire-codebase-knowledge
Ajuda seu agente a entender e documentar um projeto de código existente. É útil para novas pessoas entrarem no projeto ou para ter uma visão geral da arquitetura.
github/awesome-copilot
acreadiness-assess
Faz seu agente avaliar a prontidão de um projeto para IA e gerar um relatório. É útil para entender o quão bem um projeto está preparado para usar ferramentas de IA.
github/awesome-copilot
acreadiness-generate-instructions
Ajuda seu agente a criar instruções para ferramentas de IA baseadas em uma avaliação. É útil para melhorar a forma como a IA interage com o código e fecha lacunas identificadas.
github/awesome-copilot
acreadiness-policy
Faz seu agente ajudar a definir ou aplicar políticas para avaliação de projetos de IA. É útil para padronizar a forma como os projetos são avaliados e garantir conformidade.
github/awesome-copilot
Skills parecidas
benchmark-optimization-loop
Faz seu agente melhorar a velocidade de algo de forma medida. Ele testa várias versões e escolhe a mais rápida que ainda funciona corretamente.
affaan-m/ECC
change-impact
Ajuda seu agente a analisar o impacto de mudanças no código antes de fazê-las. Ele compara o planejado com o real depois, cobrindo caminhos, dados, testes e documentação. É útil para mudanças arriscadas ou que afetam várias partes do sistema.
affaan-m/ECC
click-path-audit
Faz seu agente rastrear todos os botões e interações do usuário para achar bugs. Ele encontra problemas onde funções parecem funcionar sozinhas, mas falham juntas. Útil quando bugs persistem mesmo após depuração.
affaan-m/ECC