What is the code comment writing standard in the process of making web pages?
I would like to share with you what the code comment writing specification is like in the process of making a web page. I believe most people don't know much about it, so share this article for your reference. I hope you will gain a lot after reading this article. let's learn about it!
Summed up the annotation writing specifications used in my work, there is no technical content, just for a unified production method, easy to maintain. It contains four parts: area comment, single-line comment, comment level, and assist comment.
Most students use the method of area annotation, which will start with "comment content" or "end of comment content", "start" or "end". In contrast, starting with "S" or "E" can be used more quickly, for example, as long as you write a start or end comment, and then copy, change "S" or "E" to finish the comment of the area quickly.
Area comment
In practical work, sometimes it is unclear whether the comment should be above or below the tag. in order to avoid this situation, the comment information is written uniformly before and after the beginning and end of the area label, and starts with "S" or "E". Indicates the beginning or end of a region comment.
Example:
...
/ * = S comment content * /
.class {
...
}
.class {
...
}
/ * = E comment content * /
Single-line comment
The comment information should be written in the content area that needs to be commented.
Example:
...
.class {
/ * comment content * /
...
}
These are all the contents of this article entitled "what is the code comment writing standard in the process of making a web page?" Thank you for reading! I believe we all have a certain understanding, hope to share the content to help you, if you want to learn more knowledge, welcome to follow the industry information channel!
