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

Two tools for splitting the screen in the Linux command line terminal

Code comment writing standards during web page production

Two tools for splitting the screen in the Linux command line terminal

Detailed explanation of how MySQL (InnoDB) handles deadlocks

The use of v-model in vue3 components and in-depth explanation

Detailed explanation of how to use Vue to load weather components

Node uses koa2 to implement a simple JWT authentication method

WeChat applet realizes simple tab switching effect

Detailed example of sharedWorker in JavaScript to achieve multi-page communication

Detailed explanation of common methods of JavaScript Array

About the role of meta in HTML (collected and sorted from the Internet)

Detailed explanation of MySQL master-slave replication practice - GTID-based replication

Recommend

Solution to "No input file specified" in nginx+php

How to configure the Runner container in Docker

MySQL 8.0.16 installation and configuration tutorial under CentOS7

MySql inserts data successfully but reports [Err] 1055 error solution

React's reconciliation algorithm Diffing algorithm strategy detailed explanation

Explore the characteristics and expressions of different spaces in HTML (recommended)

Install MySQL 5.7.17 in win10 system

Installation tutorial of the latest stable version of MySQL 5.7.17 under Linux

Several common CSS layouts (summary)

Example of how to implement a 2-column layout in HTML (fixed width on the left, adaptive width on the right)

Detailed explanation of the setting of background-image attribute in HTML

Detailed tutorial on deploying apollo with docker

mysql installer community 8.0.16.0 installation and configuration graphic tutorial

Simply master the use of horizontal line annotations and code comments in HTML

Example of JSON output in HTML format (test interface)