Tips To Improve Your Code Quality

Tips To Improve Your Code Quality

1. SPLIT YOUR CODE INTO SHORT

Every method, function, or logical code block should fit on a reasonably-sized screen window (25–50 lines long). If it's longer, split it into shorter pieces. An exception can be made for simple repetitive code sequences.

2. DON'T OVERDESIGN

Keep your design focused on today's needs. Your code can be general to accommodate future evolution, but only if that doesn't make it more complex. Avoid overdesigning it.

3. DON'T REPEAT YOURSELF

If you ever find yourself copying and pasting code, STOP and think long and hard — you’re probably doing something wrong. Keep a definitive version in one place, and let that version drive all other uses.

4. CHECK FOR ERRORS

Do recheck your codes/project, Check for Errors and Respond to Them. Don't ignore them or don't assume that everything will work fine.

5. CODE REVIEW

Code review is the ultimate test of how well your code can be understood by others. Having someone else be able to read and understand your code in front of you is the ultimate test of whether your program is going to be maintainable.

6. USE WELL-INFORMED NAMES

Use well-named functions, classes, and variables. A name should tell you the microscopic story of how a thing is used and what it represents. It shouldn’t be a single letter, like “x,” and it shouldn’t be a 70-character-long sentence full of underscores.

7. COMMENT AND DOCUMENT

Start every routine you write with a comment outlining what the routine does, its parameters, and what it returns, as well as possible errors and exceptions. Summarize in a comment the role of the contents of each class field, and the major steps of complex code.

FOR MORE TIPS AND GUIDANCE

SOCIAL MEDIA

Did you find this article valuable?

Support Pablo by becoming a sponsor. Any amount is appreciated!