Shulou(Shulou.com)06/01 Report--

In this article Xiaobian for you to introduce in detail "how to write good code in web development", the content is detailed, the steps are clear, and the details are handled properly. I hope this article "how to write good code in web development" can help you solve your doubts.

1. Coding specification

Each programming language and framework has its own set of coding specifications and coding best practices. For example, PEP8 is the coding specification of the Python language. As a Python developer, everyone should read PEP8 at least three or five times, memorize it by heart and apply it to the project.

2. Document comments

Two things programmers hate most: first, there are no documentation and comments on other people's projects, and second, they have to write documentation and comments on their own projects.

I often see some projects that don't even have a basic REAMDME file, which is no different from demo. If there is no documentation for your project, you will look confused and amateur once a new person comes in to take over. So, a serious project should at least state what the project does, what is used, how the program runs, and so on.

Simple code naturally does not need to write comments, and good code itself is documentation and comments, but if there is more complex code logic, you must use comments to explain how you thought about writing this code at that time, otherwise you don't know what bad code you wrote every two months, still scolding which idiot wrote it. Therefore, we should write notes only when we should. It is not appropriate to write too much or less. There is also a situation where out-of-date comments are found to be old after the requirement change code is updated.

Although Python is an elegant and concise language, it can't do without the help of annotations. After all, the code is written for people.

3. Avoid duplicating code

There is a DRP principle in the software design principle, that is, do not write duplicate code in a project. If the same logic appears more than twice, then you should consider encapsulating it into a function or public method. Too much repetitive code later will lead to a lot of potential problems, one problem, leading to changes everywhere.

4. Test coverage

Test-driven development (TDD) is the current mainstream development model, but we often ignore unit testing because of project schedule or laziness. Code without unit testing is like a dangerous building, you never know which holes are in it, because once you change a piece of code, you never know what impact it will have on the whole system, and unit testing is a guarantee of code quality. the higher the test coverage, the fewer potential problems.

5. Safety consciousness

Security problems are small before they occur, but once they happen, it will be an immeasurable big thing. A few years ago, a website as big as CSDN even made a joke about storing passwords in clear text, which shows how low the security meaning of programmers is. Passwords should at least be stored in HASH and salted. Last year, Dajiang programmers uploaded the server's key to github is also a typical lack of security meaning. Distinguish between what should be synchronized to the code base and what should not be put. Common web security should also be clear, such as SQL injection, the basic principles of CSRF, XSS attacks and how to prevent them.

6. Design and architecture

If the design architecture is wrong, no matter how good the code is written, it will be in vain, just like building a house with a wrong design, which is beautiful and gaudy, which may hide major security risks. Reasonable design and architecture is to make reasonable trade-offs according to the business, follow the principle of gradual evolution, and do not follow the trend by referring to the scale of BAT to design your system. Good systems are evolved. Putting aside business and talking about technology is a hooligan.

After reading this, the article "how to write good code in web development" has been introduced. If you want to master the knowledge of this article, you still need to practice and use it to understand it. If you want to know more about related articles, welcome to follow the industry information channel.

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.