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

Zusammenfassung häufig verwendeter Befehle für Linux-Dateioperationen

Standards zum Schreiben von Codekommentaren bei der Webseitenerstellung

Zusammenfassung häufig verwendeter Befehle für Linux-Dateioperationen

Der Unterschied zwischen MySQL Outer Join und Inner Join Abfrage

7 Fähigkeiten, die großartige Grafikdesigner beherrschen müssen

Welche Vorteile bietet die Verwendung des B+-Baumindex in MySQL?

Detaillierte Erläuterung des Linux-Befehls zur Änderung des Hostnamens

Vue-Ereignisparameter $event = Ereigniswertfall

Prozessdiagramm für das erste Bereitstellungs-Webprojekt von Tomcat

Vue: Wertübertragung zwischen Vater und Sohn, Wertübertragung zwischen Bruder und Kind, detaillierte Erläuterung

Detaillierte Erklärung zum Lay-Loading von JavaScript

So aktivieren Sie TLS- und CA-Authentifizierung in Docker

Artikel empfehlen

100-1% des Inhalts der Website ist Navigation

Verwenden Sie thead, tfoot und tbody, um eine Tabelle zu erstellen

Lösung für die nicht angezeigte IP-Adresse unter Linux

Einführung in die Bereitstellung des Selenium-Crawler-Programms unter Linux

Detaillierte Analyse und Verwendung des Befehls tcpdump unter Linux

So stellen Sie Oracle mit Docker auf dem Mac bereit

Tutorial zur Installation und Konfiguration von MySQL 8.0.12 unter Win10

Ein genauerer Blick auf die Unterschiede zwischen Link und @import

So verwenden Sie griechische Buchstaben in HTML-Seiten

Tutorial zur Installation von mysql5.7.17 über yum auf redhat7

Die Organisation W3C gibt Stilempfehlungen für HTML4

Webdesign-Tutorial (4): Über Materialien und Ausdrücke

Drei Möglichkeiten zum Teilen der Komponentenlogik in React

Implementierung der Datenwiederherstellung durch direktes Kopieren von Dateien im Datenverzeichnis in MySQL

React implementiert die Prinzipanalyse der drei Phasen Laden, Laden, Abschluss und Ladefehler