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: <!--=S Comment content--> <div> ... </div> <!--=E Comment content--> /*=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> <!--Comment content--> ... </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
Recommend
How to modify the forgotten password when installing MySQL on Mac
1. Install MySQL database on mac 1. Download MySQ...
Solution to elementui's el-popover style modification not taking effect
When using element-ui, there is a commonly used c...
How to reduce the memory and CPU usage of web pages
<br />Some web pages may not look large but ...
Common solutions for Mysql read-write separation expiration
The pitfalls of MySQL read-write separation The m...
How to implement https with nginx and openssl
If the server data is not encrypted and authentic...
Detailed explanation of the usage of 5 different values of CSS position
The position property The position property speci...
Practical tutorial on modifying MySQL character set
Preface: In MySQL, the system supports many chara...
How to configure Nginx's anti-hotlinking
Experimental environment • A minimally installed ...
Linux disk sequential writing and random writing methods
1. Introduction ● Random writing will cause the h...
In MySQL database, datetime, bigint, and timestamp are used to represent time selection. Which one is the most efficient for storing time?
Table of contents # Post-data preparation # SQL q...
Native JS implements a very good-looking counter
Today I will share with you a good-looking counte...
How to start jar package and run it in the background in Linux
The Linux command to run the jar package is as fo...
How to display a small icon in front of the browser URL
When you browse many websites, you will find that ...
js realizes the function of clicking to switch cards
This article example shares the specific code of ...
Nginx one domain name to access multiple projects method example
Background Recently, I encountered such a problem...