Senior developers tell you, how to write excellent code?

If you ask a senior developer , What is good code ？ His answer may be , Software that people still want to use years or decades later .

However , It is not easy for developers to write the kind of longevity software that people desire .

Boredom is not a bad thing

similar , When writing enterprise level technical code such as database , Boredom is a good thing . because , The primary consideration of an enterprise is to maintain its business 、 Keep the program running stably . therefore , It is very important to choose functions and schemes that are easy to understand .

（ Pictures come from the Internet , Infringement must be deleted ）

however “ boring ” There is another aspect of our software , That is, to adopt the most basic method to solve specific business problems . As some excellent developers do , They “ Very stupid ” Code for “ Consistently create products with great value ”, It doesn't work “ Crazy math ” Or all kinds of artificial intelligence . Their secret is “ Ask a lot of questions ”, In order to “ Know what information the business needs , Instead of actually processing data ”.

Ask questions to accurately understand what information the software needs to use and distribute to meet business needs , Keep the software simple .

This is a very valuable but often overlooked principle ： Information from  A  To  B The simpler the path , The more stable the system is . Because developers ask the right questions , So the software directly aims at the bull's-eye , Solved the actual business problems . It is the key to the long-term supportability of software .

By keeping the code as clean or concise as possible , Developers can more easily in a few months 、 Make improvements after a few years or decades .

Clearly documented

Developer advocates  Mason Egger  Once emphasized the role of development documents . Developers should clearly clarify what the document will help readers achieve , There is no need to embarrass readers through lengthy documents , Don't waste more of their time .

according to  Egger That's what I'm saying , Developers often jump directly to the sample code instead of explaining , This is why he advocates using real examples .Egger It also emphasizes the need to make documents easy to search , So that readers can quickly find the information they need . It is also important to write as simply as possible , Don't use jargon or unnecessary complex words . In a word , The goal of documentation is always to be simple and concise .

（ Pictures come from the Internet , Infringement must be deleted ）

meanwhile , For code examples and illustrative documentation , It is also necessary to check again whether you have inadvertently left errors .“ The only thing worse than no documentation is that the documentation is incorrect ,”Egger  say .“ Because no file means I have to look for it elsewhere , But incorrect documents will waste my time .”

These documentation tips help ensure that people who encounter the sample code in a few weeks or years can understand it more easily , It also means that they are likely to use it . therefore , The software itself and its documentation need to be as simple as possible today , In order to make it readable and usable in many future days .