Standards zum Schreiben von Codekommentaren bei der Webseitenerstellung

<br />Ich habe die in meiner Arbeit verwendeten Standards zum Schreiben von Anmerkungen zusammengefasst. Es gibt keinen technischen Inhalt, sie dienen lediglich dazu, die Produktionsmethode zu vereinheitlichen und die Wartung zu erleichtern. Es umfasst vier Teile: „ Regionale Kommentare “, „ Einzeilige Kommentare “, „ Kommentarebenen “ und „ Unterstützte Kommentare “.
Die meisten Schüler verwenden die Methode der Bereichsanmerkung, die mit „Anmerkungsinhalt beginnt“ oder „Anmerkungsinhalt endet“, „Start“ oder „Ende“ usw. beginnt. Im Vergleich dazu kann der Beginn mit „S“ oder „E“ schneller verwendet werden. Sie müssen beispielsweise den Start- oder Endkommentar nur einmal schreiben, ihn dann kopieren und „S“ oder „E“ ändern, um die Bereichsanmerkung schnell abzuschließen.
Bereichsanmerkung <br />Bei der tatsächlichen Arbeit ist es manchmal unklar, ob die Anmerkung über oder unter der Beschriftung stehen soll. Um diese Situation zu vermeiden, werden die Anmerkungsinformationen einheitlich vor und nach dem Beginn und Ende der Bereichsbeschriftung geschrieben und beginnen mit „S“ oder „E“, um den Beginn oder das Ende der Bereichsanmerkung anzuzeigen.
Beispiel:

<div>
...
</div>

/*=S Kommentarinhalt*/
.Klasse{
...
}
.Klasse{
...
}
/*=E Kommentarinhalt*/
Einzeiliger Kommentar <br />Kommentarinformationen sollten in den zu kommentierenden Inhaltsbereich geschrieben werden. Beispiel:
<div>

...
</div>
.Klasse{
/*Kommentarinhalt*/
...
}

Vorherige Seite 1 2 Nächste Seite Gesamten Artikel lesen

<<: Bereitstellung eines MySQL-Hochverfügbarkeitsclusters und Implementierung eines Failovers

>>: Detaillierte Erläuterung des Apache SkyWalking-Alarmkonfigurationshandbuchs

Die tdwidth-Einstellung der Tabelle in mehreren Divs ist gleich und kann nicht ausgerichtet werden

Standards zum Schreiben von Codekommentaren bei der Webseitenerstellung

Die tdwidth-Einstellung der Tabelle in mehreren Divs ist gleich und kann nicht ausgerichtet werden

Einrichten der React-Native-Umgebung und grundlegende Einführung

Detaillierte Erläuterung der Installations- und Bereitstellungspraktiken von Zabbix

Drei Strategien zum Umschreiben von MySQL-Abfrageanweisungen

Befehlsliste des Baota Linux-Panels

Zusammenfassung einiger Punkte, die bei der Registrierung von Tomcat als Dienst zu beachten sind

Lösen Sie das Problem, dass der Standardwert des CSS3-Übergangsverzögerungsattributs 0 ohne Einheit ist und ungültig ist

Referenz zur Webseitenerstellung im IE6 - Standardstil im IE6

CSS verwendet calc(), um die aktuell sichtbare Bildschirmhöhe zu ermitteln

Detaillierte Erklärung des MySQL-Datenbank-LIKE-Operators in Python

Artikel empfehlen

CSS zum Erzielen von Text auf dem Hintergrundbild

Beispielcode zur Implementierung eines Musikplayers mit nativem JS

Problemanalyse der Verwendung einer Idee zum Erstellen eines Springboot-Initialisiererservers

Attribute im Vue V-For-Loop-Objekt

So installieren Sie Tomcat8 im Docker

CentOS 7.x Docker verwendet die Overlay2-Speichermethode

Detaillierte Erklärung, warum MySQL nicht mit UNION zwei Abfragen verbinden kann

Detaillierte Erläuterung des Bereitstellungsprozesses eines SpringBoot-Projekts über das Docker-Plugin in IDEA

So bereinigen Sie Ihre Docker-Daten vollständig

So installieren Sie MySQL 8.0 in Docker

Reine CSS-Implementierung (kein Skript) Tooltip-Textaufforderungseffekt im HTML-Befehlsstil

Detaillierte Erläuterung der Implementierung gemeinsam genutzter Module in Angular-Projekten

MySQL-Lösung für zeitgesteuerte Backups (mithilfe von Linux crontab)

So implementieren Sie eine MySQL-Datenbanksicherung in Golang

Bringen Sie Ihnen bei, Dutzende von Zeilen JS zu verwenden, um coole interaktive Canvas-Effekte zu erzielen