A summary of the usage of annotations in html, css and js codes

Adding necessary comments is a good habit that a responsible and ethical front-end must have, which can greatly improve the maintainability and readability of the code. The editor below will introduce to you a summary of the standard usage of html, css and js comments. Friends who need it can refer to it

Add necessary comments, which are necessary for a responsible and ethical front-end Habits can greatly improve the maintainability and readability of code. First of all, everyone needs to be familiar with how to write comments in html, css, and js:

html comments:

css comments:

//Comment content single line comment (not recommended because some browsers may be incompatible and have no effect)
/*Comment content*/ Multi-line comments (recommended)

JavaScript:

//Comment content single-line comment
/*Comment content*/Multi-line comments

Summary:

//Comment content (Insert single-line comments in css or javascript)
/*Comment content*/ (Insert multi-line comments in css or javascript)

The following is a summary of where comments are used in these types of codes and how to write comments. (It may vary according to personal habits)

1. HTML comment

Used location:

1) Generally used in some major nodes After the end of the label, such as:

<p class="wrap">
<p class="main">
...
</p><!--main end-->
<p><!--wrap end-->

2) Used after the end of some loops, such as:

<ul class="list">
    <li>111111</li>
    <li>222222</li>
    <li>333333</li>
</ul><!--list loop-->

All this is to make the program more convenient and clear when nested. When it is convenient for others, it is also convenient for yourself. The nesting of programs is very messy, and it will be a very complicated process for you to modify it.

2. CSS comments

are generally used when defining a certain module style to indicate which module this style is applied to, such as:

/*通用 - 评论*/
.comment{...}
/*相册*/
.photo{...}
/*分享*/
.share{...}
/*投票*/
.vote{...}

3. JavaScript comments

Generally, comments are added above a certain function to explain the function, author, and author information of the function. ,Change the time.

//========================================================
//      截断字符
//      steepvi
//      rtx:*******
//      2010-10-14
//========================================================

Finally, comments are also characters and will generate traffic. Therefore, when the page is published to the official address, it is best to add an optimization process.

The compression process is a non-reverse process, ensuring that the local file is the latest and has comments, and is uploaded to the server after compression. Server-side files cannot be used for local debugging.

The above is the detailed content of A summary of the usage of annotations in html, css and js codes. For more information, please follow other related articles on the PHP Chinese website!