Code formats and comments are one of the things you can only notice if you don’t have code. If used to properly display and record the code, the existence of the missing code block is known only when it is first touched. Sooner or later, most people who run or own websites will face changing the code base. This may be the time to create new HTML elements, insert some custom CSS, or change the word press PHP template. To avoid a mess, we’ll look at best practices for code formatting and annotations in our post. You will learn why they are necessary and how to use them correctly. The
Since there are many programming and annotation languages with different rules, we limit them to the most common ones in web design, namely HTML, CSS, PHP, and JavaScript. Why format and record code? Before I explain the method, let me talk about why this is important. The function does not require a code format. First, functions do not actually require formatting code and annotation processing. A machine like a browser can read and run completely without a browser. This is why you can use techniques such as zoom out to speed up your WordPress site. The
The computer does not care whether the code is beautiful or not, unless the code is correct and causes errors. However, annotations are easier to read. But do you know who cares about code formatting and comments? human People like you and me sometimes need to read, understand, and modify code. In this case, the code is easier to understand if it is properly formatted and \/ or annotated. Disabling formatting in code is the same as disabling formatting in composition. No matter how good the content is, if the paragraph and title are deleted, you will not read the post. The
For this reason, people have come up with rules to make the code as easy to understand as possible. This prevents errors, solves problems, and makes it easier for others (or your own work) to maintain. This is a necessary part of the code format, but it is important to know that there is no ultimate way to specify the code style. For example, different formats may apply to different dimensions. Applying CSS formatting to HTML or vice versa is not necessarily easy to understand. Therefore, there are different rules depending on the language you use. By default, however, all content is centered on: The
Developers often use unique styles according to their preferences in the wide range of rules such as the use of indented margins, capital letters, naming rules, styles such as functions and variables, and the use and style of spelling notes. However, there are several very common code formats and annotation elements that we will discuss below. Code formatting approach – the basic principles now provide some guidance on how to specify the code format to make it easier to work. Layout – use indenting, line wrapping, and formatting appropriate layouts to help identify code parts, such as those that belong together and are interdependent. For this purpose, the default tools are indent, newline, and other formatting options. The methods used in various programming languages are as follows: The
HTML HTML annotations usually indent elements, and display elements overlap each other. You can do this with labels or multiple spaces. Although there is a discussion about what the right way to do this is (amazing!) You can choose the method that suits you. Proper indentation also places the closing parentheses of containers (such as div elements) at the same vertical level, so it is easy to see if they are closed. After adding comments (as shown below
In vascript, you can also view it in camelCase, under_scots, or with hyphens under_scores. Which is right? Well, they all work, so there is no wrong solution (except for hyphens in JavaScript, which may have a minus sign). As a result, the most important thing here is to decide and stick to one. In addition, we recommend that you view the rules for the platform you are working on. For example, WordPress suggests that PHP use underscores and JavaScript use camelCase. Therefore, if you use the WordPress platform to work, especially many existing variables already exist in this format, it is best to adhere to these rules. Code annotation best practices, as shown above, will allow other developers to see progress very quickly each time they view your task. In this case, the code is called \
There are differences. The most important thing is consistency. If you determine the format style, make sure that the format style does not deviate from the style, especially in the same file or project. Otherwise, the reason that part of the code format exists from the beginning is invalid. If you work with a team, creating style guides may help maintain consistency. What is your favorite code formatting and code annotation tool? Do you have anything to add to the above? Please inform the comments section below.
