Voltar ao índice
Ferramentas e automação Fonte oficial

Boas práticas de programação assíncrona em C#

Orienta APIs assíncronas em C# com Task, ValueTask, cancellation tokens, tratamento de erros, paralelismo e prevenção de bloqueios.

Ver código no GitHub Instala diretamente do repositório-fonte.

O que esta skill faz

Esta skill ajuda a escrever e revisar código assíncrono segundo o padrão TAP do C#. Ela aborda nomes com sufixo Async, retornos Task, exceções, ConfigureAwait, Task.WhenAll, Task.WhenAny, streams assíncronos e armadilhas de bloqueio.

Quando usar

  • Projetar métodos públicos assíncronos
  • Substituir .Wait() ou .Result por fluxos com await
  • Executar tarefas independentes com Task.WhenAll
  • Adicionar cancelamento a operações demoradas
  • Processar sequências com IAsyncEnumerable

Como usar

  1. Revise o repositório e localize métodos async, chamadas bloqueantes e Tasks não aguardadas
  2. Ajuste nomes e tipos de retorno conforme a responsabilidade do método
  3. Propague erros e cancellation tokens de forma explícita
  4. Use paralelismo somente entre operações realmente independentes
  5. Execute testes para sucesso, falha, cancelamento e timeout

O que revisar antes de instalar

  • ValueTask deve ser reservado a cenários com benefício comprovado
  • ConfigureAwait(false) depende do contexto, especialmente em código de biblioteca
  • Task.WhenAll não torna operações dependentes seguras para execução paralela

SKILL.md

---
name: csharp-async
description: 'Get best practices for C# async programming'
---

# C# Async Programming Best Practices

Your goal is to help me follow best practices for asynchronous programming in C#.

## Naming Conventions

- Use the 'Async' suffix for all async methods
- Match method names with their synchronous counterparts when applicable (e.g., `GetDataAsync()` for `GetData()`)

## Return Types

- Return `Task<T>` when the method returns a value
- Return `Task` when the method doesn't return a value
- Consider `ValueTask<T>` for high-performance scenarios to reduce allocations
- Avoid returning `void` for async methods except for event handlers

## Exception Handling

- Use try/catch blocks around await expressions
- Avoid swallowing exceptions in async methods
- Use `ConfigureAwait(false)` when appropriate to prevent deadlocks in library code
- Propagate exceptions with `Task.FromException()` instead of throwing in async Task returning methods

## Performance

- Use `Task.WhenAll()` for parallel execution of multiple tasks
- Use `Task.WhenAny()` for implementing timeouts or taking the first completed task
- Avoid unnecessary async/await when simply passing through task results
- Consider cancellation tokens for long-running operations

## Common Pitfalls

- Never use `.Wait()`, `.Result`, or `.GetAwaiter().GetResult()` in async code
- Avoid mixing blocking and async code
- Don't create async void methods (except for event handlers)
- Always await Task-returning methods

## Implementation Patterns

- Implement the async command pattern for long-running operations
- Use async streams (IAsyncEnumerable<T>) for processing sequences asynchronously
- Consider the task-based asynchronous pattern (TAP) for public APIs

When reviewing my C# code, identify these issues and suggest improvements that follow these best practices.