KISS
Writing Self-Documenting Code
Tip: Aim to write code that is clear enough to understand without requiring extensive comments. Use comments to explain the "why" behind decisions rather than the "what" of the code.
Example:
public double CalculateDiscount(double originalPrice, double discountRate)
{
// Ensure the discount rate is between 0 and 1
if (discountRate < 0 || discountRate > 1)
{
throw new ArgumentOutOfRangeException(nameof(discountRate), "Discount rate must be between 0 and 1");
}
return originalPrice * (1 - discountRate);
}
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.