csharp-async

por github

We need to translate the given text from English to Brazilian Portuguese. The text is about best practices for C# asynchronous programming. We must preserve the name "csharp-async" but it's not in the text, so ignore. Also preserve technical terms like Task, ValueTask, ConfigureAwait, Task.FromException, Task.WhenAll, Task.WhenAny, .Wait(), .Result, async void. Also preserve "Async suffix" as "sufixo Async" maybe? But careful: "Async suffix" is a term, we can translate "suffix" to "sufixo" and keep "Async" as is. Also "cancellation token" -> "token de cancelamento". The text is a single paragraph. We need to output only the translation, no extra commentary. Let's translate: "Best practices guide for C# asynchronous programming patterns and pitfalls." -> "Guia de melhores práticas para padrões e armadilhas de programação assíncrona em C#." "Covers naming conventions (Async suffix), return types (Task,

npx skills add https://github.com/github/awesome-copilot --skill csharp-async

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) 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.