Code comment writing standards during web page production

<br />I have summarized the annotation writing standards used in my work. There is no technical content, it is just used to unify the production method and facilitate maintenance. It includes four parts: " Regional Comments ", " Single-Line Comments ", " Comment Levels " and " Assisted Comments ".
Most students use the method of area annotation, which starts with "annotation content begins" or "annotation content ends", "start" or "end", etc. In comparison, starting with "S" or "E" can be used faster. For example, you only need to write the start or end comment once, then copy it, and change "S" or "E" to quickly complete the area annotation.
Area annotation <br />In actual work, it is sometimes unclear whether the annotation should be above or below the label. To avoid this situation, the annotation information is uniformly written before and after the start and end of the area label, and starts with "S" or "E" to indicate the start or end of the area annotation.
example:

<div>
...
</div>

/*=S Comment content*/
.class{
...
}
.class{
...
}
/*=E Comment content*/
Single-line comment <br />Comment information should be written in the content area to be commented on. Example:
<div>

...
</div>
.class{
/*Comment content*/
...
}

Previous Page 1 2 Next Page Read Full Article

<<: MySQL high availability cluster deployment and failover implementation

>>: Detailed explanation of Apache SkyWalking alarm configuration guide