suriya-mca / clean_code

Coding Best Practices and Principles

Clean Code Best Practices

Java:

1. Keep functions concise, ideally not exceeding 60 lines.
2. Employ interfaces for repositories.
3. Prefer composition over inheritance when connecting classes for creating complex structures.
4. Utilize records for defining data models.
5. Consider using concurrency mechanisms over traditional multithreading approaches.
6. Don't use comments in your code; prioritize writing self-explanatory code.
7. Don't use a try-catch block; implement global exception handling.

Python:

1. Embrace object-oriented programming (OOP) principles but prioritize "Functional Programming" paradigms.
2. Keep functions concise, ideally limited to 60 lines.
3. Enhance code readability by incorporating type hints.
4. Utilize Pydantic for robust data validation.
5. Consider leveraging asynchronous programming for improved performance.
6. Don't use comments in your code; prioritize writing self-explanatory code.
7. Don't use a try-catch block; implement global exception handling.

APIs Best Practices:

1. Avoid designing APIs with bulk payloads; break down the API into smaller components.
2. Implement API versions to manage changes and updates effectively.
3. Utilize throttling mechanisms to control the number of requests the API can process.
4. Implement rate-limiting strategies to regulate how frequently the API can be accessed.
5. Implement caching (Save frequently used data to speed up responses).
6. Implement connection pooling (Reuse existing database connections to save time and resources).

Principles:

1. DRY (Don't repeat yourself)
2. KISS (Keep it simple stupid)