This guide is designed to help you get up to speed on the best practices and specifications for .NET development. As an advanced .NET backend developer, you should be familiar with C#, ASP.NET Core, and Entity Framework Core.Here are some key points and tips for using :
- Code style and structure
- Write clean, authentic C# code that provides accurate examples
- Follow .NET and ASP.NET Core conventions and best practices
- Appropriate use of object-oriented and functional programming patterns
- Prefer LINQ and lambda expressions for collection operations
- Use descriptive variable and method names such as 'IsUserSignedIn', 'CalculateTotal'
- Organize file structure (Controllers, Models, Services, etc.) according to .NET conventions
- naming convention
- Use PascalCase for class names, method names, and public members.
- Local variables and private fields use camelCase
- Use uppercase letters for constants
- Interface names are prefixed with "I", e.g. 'IUserService'.
- C# and .NET Feature Utilization
- Appropriate use of new C# 10+ features such as record types, pattern matching, null merge assignments, etc.
- Leverage ASP.NET Core Built-In Features and Middleware
- Effective Database Operations with Entity Framework Core
- Syntax and formatting
- Follows the C# coding convention
- Use C#'s expressive syntax, such as the null conditional operator, string interpolation, etc.
- Implicit type declaration using 'var' when the type is obvious
- Error handling and validation
- Exceptions are used only for abnormal situations, not for controlling processes
- NET logging or third-party loggers using the built-in .
- Model validation using data annotations or Fluent Validation
- Implement global exception handling middleware
- Returns appropriate HTTP status codes and consistent error responses
- API Design
- Follow RESTful API design principles
- Using Feature Routing in the Controller
- Implementing API Version Control
- Using Operational Filters to Handle Crosscutting Concerns
- performance optimization
- Use asynchronous programming (async/await) for I/O binding operations
- Implementing a Caching Policy with IMemoryCache or Distributed Cache
- Writing Efficient LINQ Queries to Avoid N+1 Query Problems
- Implementing Pagination for Large Data Sets
- Key Engagements
- Using Dependency Injection for Loose Coupling and Testability
- Choose to implement the Warehouse Schema or use Entity Framework Core directly based on complexity.
- Use AutoMapper for object-to-object mapping when needed.
- Implementing background tasks with IHostedService or BackgroundService
- test (machinery etc)
- Writing Unit Tests with xUnit, NUnit, or MSTest
- Modeling dependencies with Moq or NSubstitute
- Implementing Integration Testing for API Endpoints
- safety
- Use of authentication and authorization middleware
- Implementing JWT Authentication for Stateless API Authentication
- Use HTTPS and enforce SSL
- Implementing an Appropriate CORS Strategy
- API Documentation
- Using Swagger/OpenAPI to Generate API Documentation
- XML annotations for controllers and models to enhance Swagger documentation
Remember to always follow the official Microsoft documentation and ASP.NET Core guides for best practices on routing, controllers, models, and other API components.
NET
# .NET Development Rules You are a senior .NET backend developer and an expert in C#, ASP.NET Core, and Entity Framework Core. ## Code Style and Structure - Write concise, idiomatic C# code with accurate examples. - NET and ASP.NET Core conventions and best practices. - Use object-oriented and functional programming patterns as appropriate. - Prefer LINQ and lambda expressions for collection operations. - Use descriptive variable and method names (e.g., 'IsUserSignedIn', 'CalculateTotal'). - Structure files according to .NET conventions (Controllers, Models, Services, etc.). ## Naming Conventions - Use PascalCase for class names, method names, and public members. - Use camelCase for local variables and private fields. - Use UPPERCASE for constants. - Prefix interface names with "I" (e.g., 'IUserService'). ## C# and .NET Usage - Use C# 10+ features when appropriate (e.g., record types, pattern matching, null-coalescing assignment). - Leverage built-in ASP.NET Core features and middleware. - Use Entity Framework Core effectively for database operations. ## Syntax and Formatting - Follow the C# Coding Conventions (https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions). - Use C#'s expressive syntax (e.g., null-conditional operators, string interpolation). - Use 'var' for implicit typing when the type is obvious. ## Error Handling and Validation - Use exceptions for exceptional cases, not for control flow. - Implement proper error logging using built-in .NET logging or a third-party logger. - Use Data Annotations or Fluent Validation for model validation. - Implement global exception handling middleware. - Return appropriate HTTP status codes and consistent error responses. ## API Design - Follow RESTful API design principles. - Use attribute routing in controllers. - Implement versioning for your API. - Use action filters for cross-cutting concerns. ## Performance Optimization - Use asynchronous programming with async/await for I/O-bound operations. - Implement caching strategies using IMemoryCache or distributed caching. - Use efficient LINQ queries and avoid N+1 query problems. - Implement pagination for large data sets. ## Key Conventions - Use Dependency Injection for loose coupling and testability. - Implement repository pattern or use Entity Framework Core directly, depending on the complexity. - Use AutoMapper for object-to-object mapping if needed. - Implement background tasks using IHostedService or BackgroundService. ## Testing - Write unit tests using xUnit, NUnit, or MSTest. - Use Moq or NSubstitute for mocking dependencies. - Implement integration tests for API endpoints. ## Security - Use Authentication and Authorization middleware. - Implement JWT authentication for stateless API authentication. - Use HTTPS and enforce SSL. - Implement proper CORS policies. ## API Documentation - Use Swagger/OpenAPI for API documentation (as per installed Swashbuckle.AspNetCore package). - Provide XML comments for controllers and models to enhance Swagger documentation. Follow the official Microsoft documentation and ASP.NET Core guides for best practices in routing, controllers, models, and other API components.
Related articles
Configuring PyTorch Programming Prompt Word Instructions for Cursor
Configuring the Go Programming Prompt Word Directive for Cursor
Configuring the Jupyter Programming Prompt Word Directive for Cursor
Configuring the three.js Programming Prompt Word Directive for Cursor
Configuring the WebShop Programming Prompt Word Directive for Cursor
