Question

Give the top 5 coding style rules you consider to be important and that you apply in your own code. In other words, if you were reviewing somebody else’s code, what would you look for when considering whether the code was well written and maintainable?

Answer 1

1. Write your code in a way that anyone who sees it would be able to understand it. It would help you to maintain your easily. In case if you come back to our code after many days, you can easily understand it without any confusion, it will also help others to understand easily. Also, use comments to explain your code whenever it is required. Code which is easy to understand is always a pro tip.

2. Never allow your private functions to present output to UI. The private function is only intended to perform an operation that we would like to do it in a secure way. So always avoid printing outputs from private methods or giving results from private functions.

3. It is very important to test the code once it is written, Without proper testing no coding is complete. You have to check in all the possible cases before finalizing your code. Tools like JUnit helps us to maintain the testing accuracy.

4. Don't write the unnecessary code or the code that makes the required functionality complex. Select a simple way of coding with which we can easily achieve the required functionality, If you are stuck at a point it is always suggested to take a break and then continue.

5. After writing the code check whether you have written the code with any complaints. Use sonar Qube analysis, to check it. Sonar Qube analysis helps us to identify bugs, vulnerabilities, major issues, minor issues, code smells and duplicates in the code. If a programmer is able to develop a code which is free from sonar issues then it can be considered that your programming skills are up to the mark.