6fb794bc79
* Delete outdated development instructions for Next.js + Tailwind and Python; add comprehensive guidelines for PostgreSQL DBA, Angular, ASP.NET REST APIs, Azure Functions with TypeScript, Bicep, Blazor, CMake with vcpkg, C#, .NET MAUI, GenAIScript, Terraform for Azure, localization, and markdown standards. * Update documentation and prompts for consistency and clarity - Standardized description formatting in various markdown files to use single quotes. - Added error handling utility in update-readme.js for safer file operations. - Improved title extraction logic in update-readme.js to handle frontmatter more robustly. - Updated chat modes section in README to reflect new emoji and sorted chat mode links. - Cleaned up various instruction files for better readability and consistency. - Ensured all markdown files end with a newline for better compatibility with version control. * Remove standardize-frontmatter.js script * Add usage instructions for creating and switching chat modes in README.md * Update README.md generation script to enhance instructions and usage details for custom chat modes * Update README.md and update-readme.js for improved instruction clarity and consistency * Refactor README.md links and update readme script for improved clarity and consistency in instructions * Update README.md and update-readme.js for improved instruction clarity and consistency * Changing from a patch to regen approach for the readme * Bit more cleanup for how to show things in the readme * Adding missing description * Another missing description --------- Co-authored-by: Aaron Powell <me@aaron-powell.com>
51 lines
1.9 KiB
Markdown
51 lines
1.9 KiB
Markdown
---
|
|
mode: 'agent'
|
|
tools: ['changes', 'codebase', 'editFiles', 'problems']
|
|
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.
|