Developer's Best Practices(开发人员最佳实践）

What is Practice?

• Practice is a habit.
• Practice is a routine.
• Practice does need to remember.
• Practice comes by practising.
• Practice needs dedication and commitment

Skills ===》 Practice ===》 【habit and routine】

For example, your feet goes automatically at brake if you see a red light but definitely it comes from practising a lot and needs a lot of dedication and commitment.

To become a 【successful】software developer you need a lot of practice, dedication, and commitment.

Best Practice 1- Keep Reading Existing Software Source Code

If you want to become a novelist, can you just start with novels? I would say 100% no!, you definitely need to read hundreds of novels before start writting GOOD novels.

There are many attributes of software codes(indentation, comments, history header, function structure, etc.) which we will learn by reading exsiting code, specially, a code written by well-experienced software developers.

Best Practice 2- Complete your documents before next step

Before we start developing small or big software, we should have answer for the following questions:

• Where is the Reqirements Specification?
• Where is the Impact Analysis Document?
• Where is the Design Document?
• Have you documented all the assumptions, limitations properly?
• Have you done review of all the documents?
• Did you get sign off on all the documents from all the stakeholders?

Best practice is to complete all the required documentation and take appropriate approvals before proceeding for the software coding.

Prepare you for tomorrow!

The following point will prepare you for future:

• Design Approaches
• Tips and Tricks
• Special functions, commands and instructions
• Lessons learnt
• Peculiar situations
• Debugging methods
• Best Practices
• Anything which can help you in future

Best Practice 3 - Code review

While writing your software code, keep in mind that someone is going to review your code and you will have to face criticism about one or more of the following points but no limited to :

• Bad coding
• Not following standard
• Not keeping performance in mind
• History, Indentation, Comments are not appropriate
• Readability is poor
• Open files are not colsed
• Allocated memory has not been released
• Too many global variables
• Too much hard coding
• Poor error handling
• No modularity
• Repeated code

Keep all the above-mentioned points in our mind while coding and stop them before they jump in your souorce code.
Once you are done with your coding, go for a self-review atleast once.
⭐️ Accepting review comments happily and should be thankful to your code reviewers about the comments.
⭐️ It is never good to criticize any source code written by someone else. (If you never did it, try it once and check the code's expression)

Accpet criticism but don't criticize.

Your target should be to stop the bugs at first place and create a BUG-FREE code. Think like a tester, so that you should have a challenge for the testers.

Best Practice 4 - Testing to be followed like a religion

Testing is mandatory(adj. 强制的；托管的；命令的) after every small or big change no matter how tight schedule you have or you just changed a small comment inside the code, you have testing due for the changed code.
There is nothing like trust while developing software, no matter how expert(精明) or how senior(资深) you are in writting source code, you would have to perform testing for each and every change you did in the code.

• Tight schedule, no compromise.
• Changed just a comment, still you have to test it.
• Changed just a variable name, testing has to be done.
• If you feel lazy... it is too dangerous

Celebrate every bug you find | What you learn today, prepares you for tomorrow

Best Practice - 5 Eager to learn

I'm not suggesting you to bother someone unreasonably and asking for spoon feeding to learn anything. NO, be polite, thankful, directly come to the point, understand and support others.

参考链接: https://www.tutorialspoint.com/developers_best_practices/eager_to_learn.htm