Shulou(Shulou.com)05/31 Report--

This article will explain in detail how to develop a good Linux coding style, the content of the article is of high quality, so the editor will share it with you for reference. I hope you will have a certain understanding of the relevant knowledge after reading this article.

The Linux operating system is an open source operating system, so you develop a tool software on the Linux system, including the source code, which may also be needed by other system administrators. For this reason, you need to follow certain rules when writing code. This is not only for the convenience of others to read, but also for future maintenance and upgrade considerations. Specifically, the author believes that Linux system administrators should develop some of the following good coding styles.

First, reasonable prevention and control function at the beginning of the left curly bracket.

Depending on the coding style accepted by most system administrators, the left parenthesis at the beginning of the function is often placed on the far left side of the code page. Avoid placing other parentheses (including left curly brackets, left brackets, or left brackets) to the far left. This is mainly for ease of reading. Because the main content of a function is often enclosed by a pair of curly braces. If there are only curly braces representing the function on the far left of the code page, you can see the body of the function at a glance. For this reason, this is a good way to improve the readability of the code.

It is important to note that this may be different from the programming style of other languages. For example, on the Java or C language platforms, the curly braces at the beginning of the function body are often placed after the function. For example, the {left curly bracket is used directly after the main function. However, this is not conducive to the reading of the program, and it is not conducive for the Linux system administrator to find the body code of the function. For this reason, if you are a system administrator who has experience with other programming languages, you can change this writing habit. The author suggests that the system administrator still put the curly braces on the far left and make sure that throughout the code, the left-most curly braces are the curly braces of the main body of the code function.

Second, there is a brief description of the function at the beginning of each function.

In the functional code of Linux, each function is also composed of functions or programs. In other words, there may be many functions in a code file. So what are these functions mainly used to achieve? If you don't make any instructions, you won't know this information until you've seen all the code of the function. This will cause a big obstacle for others to read the source code. Moreover, after a long time, even the system administrator may not know what function this function is used to achieve. This is obviously disadvantageous to its follow-up maintenance and upgrade. For this reason, the author suggests that system administrators, whether for themselves or for others, write a short comment at the beginning of each function or program. A good memory is not as good as a bad pen, which makes the code easier to read. In addition, it should be noted that as the Linux system may not support Chinese very well, it is written in English when writing this comment. Because in some systems that do not support Chinese very well, the Chinese will be displayed as garbled, which will not play its due role at this time. If you don't know English, you may have to use pinyin. Of course it's just a joke. Generally speaking, Linux system engineers need some knowledge of English. Because the help documents in the Linux operating system are written in English. Therefore, this English language barrier is also a barrier that the system administrator must solve.

In addition, when explaining the function, * * also needs to know what parameters the function needs to pass in by the user and what results will be returned. And the parameters, the number of results, and so on. This is very helpful for code compilation and maintenance. And if other members of the project team want to reference your function, you don't need to look at the specific code of the function. You only need to look at some of this comment to know which parameters need to be passed in. This is also a means to improve the efficiency of project cooperation.

Third, the use of If statements should be standardized.

IF statements are one of the most frequently used structures when writing code in Linux systems. This if statement is mainly used to make some logical judgments. Although the statement itself is relatively simple, * can also follow some rules when using this statement. Although these rules are mainly considered from the perspective of readability, they are also helpful for writing an accurate IF structure statement.

For example, according to the programming habits of the Linux system, do not assign values in the conditions of IF. The IF statement needs to determine what action to take based on certain conditions. In this condition, variables can be assigned in this condition according to syntax. But this is not in line with the programming style of the Linux system. The author suggests that * * assign a variable outside the IF structure, and then use the variable directly in the condition. This makes it easier to control the IF structure. In addition, if you use nesting in an IF statement, you can use curly braces to enclose the nested IF ELSE statement to facilitate the discovery of the nested statement. In other application writing processes, indentation is used to highlight the IF nested structure. But Linux system administrators prefer to use curly braces. Although there is no substantial difference between the two, the author still recommends the use of curly braces. Because this is a Linux operating system industry generally recognized as a coding style.

Fourth, uppercase and lowercase writing should be standardized.

Although function or variable names are allowed to use uppercase or lowercase characters. However, when defining these names, uppercase and lowercase still follow some common rules. For example, use lowercase English characters for the name of the function. If it is made up of multiple words, * use an underscore to divide it. Instead of capitalizing * English words. Mixed case may be a good solution in some environments, but not in Linux systems. For variables, determine whether to use lowercase characters or uppercase characters based on the type of variable. In general, if the variable is defined by the system administrator, then * use lowercase characters. If you are using system variables, you can use uppercase letters. In this way, as soon as you see the uppercase or lowercase state of the variable, you can determine whether you are using a user-defined variable or a system variable. In addition, some constants are also needed in the Linux system. According to everyone's programming habits, uppercase characters are often used to define constants. For example, in the process of learning the code written by other experts, system administrators can find that uppercase characters are used to represent constants in enumerations or macros.

Before deciding whether to use uppercase or lowercase characters, it is important to be clear that case is sensitive in the Linux operating system. In other words, Name and name represent two different variables. Therefore, it is particularly important to standardize the case format in the system. Because of case sensitivity, mixing case in the same name can complicate the application of variables or functions. Therefore, if a name is made up of several words, the system administrator should be used to using underscores for word segmentation, rather than capitalizing words.

Fifth, the code of the branch is the need for a branch.

Although the compiler of the Linux operating system does not have strict requirements for branches. For example, several variables can be defined in the same row, or multiple variables can be assigned in the same row, and so on. As long as the appropriate separator is used, it can be compiled and executed correctly. But if the system administrator really does so, then the author tells you that you will be laughed at by your peers. Because it makes you unprofessional. According to the general programming style of the Linux operating system, this branch needs a branch when writing code.

For example, when a variable or constant is defined, it is usually defined as a variable or constant on one line. When writing complex structure statements, such as IF or loop structures, it is often in the form of branches. Even if the code is simple, it can be written in one line. But it will still be divided into two or more lines according to its different parts. This helps the system administrator to read the code. In addition, in different parts of the program, branches can also be used for isolation. Such as between functions, between variable declarations and functions, between comments and code, and so on. You can add one or two blank lines to improve the convenience of reading. Anyway, this will not affect the performance of the program.

There are many similar coding styles. For example, the operation symbols of two different operation levels should not appear in the same line; do not declare multiple variables across lines, that is, the declaration of variables should be placed in the same place to facilitate the same management, and so on. These rules need to be understood and summarized in the code written by other system administrators. Take a look at the code written by some experts, which can often bring us a lot of gains.

On how to develop a good Linux coding style to share here, I hope the above content can be of some help to you, can learn more knowledge. If you think the article is good, you can share it for more people to see.

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.