Summary of standard usage of html, css and js comments

Summary of standard usage of html, css and js comments

Adding necessary comments is a good habit that a responsible and moral front-end developer must have, which can greatly improve the maintainability and readability of the code. First of all, you need to be familiar with the writing of comments in html, css, and js:

HTML comments:

<!--Comment content-->

CSS comments:

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

JavaScript:

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

Summarize:

//Comment content (insert single-line comments in CSS or JavaScript)
/*Comment content*/ (Insert multiple lines of comments in CSS or JavaScript)

Next, we will summarize where comments are used in these types of code and how to write comments. (It may vary according to personal habits)

1. HTML comments

Where used:

1) It is usually used after the end of some main node labels, such as:

<div class="wrap">
<div class="main">
...
</div><!--main end-->
<div><!--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 of this is to make the program more convenient and clear when nesting. Making things convenient for others also makes things convenient for yourself. The programs are nested very messily, and it will be a very complicated process for you to modify them.

2. CSS comments

It is usually used above the definition of a module style to indicate which module this style applies to, such as:

/*General - Comments*/
.comment{...}
/*Photo Album*/
.photo{...}
/*share*/
.share{...}
/*vote*/
.vote{...}

3. JavaScript comments

Comments are usually added above a function to describe the function, author, author information, and modification time.

//========================================================
//Truncate characters//steepvi
//rtx:*******
// 2010-10-14
//========================================================

Finally, comments are also characters that 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-reversible process, which ensures that the local file is the latest and annotated file, and is uploaded to the server after compression. Server-side files cannot be used for local debugging.

The above is a summary of the standard usage of HTML, CSS and JS comments introduced by the editor. I hope it will be helpful to everyone. If you have any questions, please leave me a message and the editor will reply to you in time. I would also like to thank everyone for their support of the 123WORDPRESS.COM website!

<<:  Bootstrap 3.0 study notes page layout

>>:  Concat() of combined fields in MySQL

Recommend

Detailed explanation of querying JSON format fields in MySQL

During the work development process, a requiremen...

Detailed explanation of JavaScript prototype chain

Table of contents 1. Constructors and instances 2...

Button is stretched on both sides in IE

When you write buttons (input, button), you will f...

Detailed steps for installing Tomcat, MySQL and Redis with Docker

Table of contents Install Tomcat with Docker Use ...

Complete steps to quickly build a vue3.0 project

Table of contents 1. We must ensure that the vue/...

Use PS to create an xhtml+css website homepage in two minutes

There are too many articles about xhtml+css websi...

Why node.js is not suitable for large projects

Table of contents Preface 1. Application componen...

Detailed explanation of Vue's keyboard events

Table of contents Common key aliases Key without ...

Detailed explanation of MySQL InnoDB secondary index sorting example

Sorting Problem I recently read "45 Lectures...

mysql method to recursively search for all child nodes of a menu node

background There is a requirement in the project ...

Tutorial on installing Tomcat server under Windows

1 Download and prepare First, we need to download...

A brief discussion on MySQL temporary tables and derived tables

About derived tables When the main query contains...