No matter what language you are using, it’s very important, again, VERY IMPORTANT, to write a human-readable or human-friendly code. This simply means, the code will need to be readable NOT just by machine, but also by human being.
- Do not write for yourself, consider others.
- Do not assume your peer / successor will figure out how your code work.
- Use indentation to separate block of code.
- Include necessary, descriptive, plain English (no heavy-technical buzz words), and straight-forward comments.
- Use already-established, easy-to-understand, widely-known naming convention, and standard, and stick with it!
- Do not create your own design pattern, unless you are 100% scientist. There are many well-known and widely-accepted patterns out there.
- Do not write complicated, more-than-necessary, excessively-repetitive-loop of workflow.