KISS
Keeping Functions and Classes Small
Tip: Design functions and classes to do one thing and do it well. Large functions and classes can be difficult to understand and maintain.
Example:
public class OrderService
{
public void ProcessOrder(Order order)
{
ValidateOrder(order);
CalculateOrderTotal(order);
SaveOrder(order);
}
private void ValidateOrder(Order order)
{
// Validation logic
}
private void CalculateOrderTotal(Order order)
{
// Calculation logic
}
private void SaveOrder(Order order)
{
// Persistence logic
}
}
General Tips!
- Implement Simple Solutions: Choose the simplest solution that meets the requirements without adding unnecessary complexity.
- Write Clear Code: Ensure your code is easy to read and understand by using clear naming conventions and straightforward logic.
- Avoid Overengineering: Resist the urge to add features or complexity that aren't needed for the current task.
- Refactor Regularly: Continuously improve and simplify your code through regular refactoring to remove unnecessary complexity.
- Follow Conventions: Stick to established coding standards and best practices to maintain simplicity and consistency.