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

Detaillierte Schritte zur Installation von Python 3.7 auf CentOS 6.5

Eine kurze Analyse des Problems der Mysql 8.0-Version, das getTables dazu veranlasst, alle Datenbanktabellen zurückzugeben

Artikel

Eine Codezeile löst verschiedene IE-Kompatibilitätsprobleme (IE6-IE10)

Standards zum Schreiben von Codekommentaren bei der Webseitenerstellung

Detaillierte Schritte zur Installation von Python 3.7 auf CentOS 6.5

Vue implementiert den automatischen Sprung zur Anmeldeseite, wenn das Token abläuft

Implementierung von erzwungenen Zeilenumbrüchen und Nicht-Zeilenumbrüchen in div, td, p und anderen Containern in HTML

Detaillierte Erläuterung der sieben Wertübertragungsmethoden von Vue

Eine Liste der Fallstricke beim regulären JS-Matching

Eine kurze Analyse des Problems der Mysql 8.0-Version, das getTables dazu veranlasst, alle Datenbanktabellen zurückzugeben

Eine Codezeile löst verschiedene IE-Kompatibilitätsprobleme (IE6-IE10)

Axios storniert wiederholte Anfragen

Zusammenfassung von 9 hervorragenden Codevergleichstools, die unter Linux empfohlen werden

Analyse des SELECT-Abfrageausdrucks in der MySQL-Datenbank

Artikel empfehlen

Detaillierte Schritte zum Debuggen von VUE-Projekten in IDEA

MySQL-Sortierung – Chinesische Details und Beispiele

Detaillierte Erläuterung der Routing-Parameterübergabe und der komponentenübergreifenden Parameterübergabe in Vue

Vue implementiert Funktionen zum Hinzufügen, Löschen und Ändern des lokalen Speichers

js-Lernnotizen: Schlüsselwörter „class“, „super“ und „extended“

So installieren und konfigurieren Sie Redis in CentOS7

Zusammenfassung der MySQL-Entwicklungsstandards und -Nutzungskenntnisse

Detaillierte Erklärung zum Erstellen geplanter MySql-Aufgaben in Navicat

Teilen Sie 13 hervorragende Web-Wireframe-Design- und Produktionstools

Einfaches HTML-Applet für Einkaufsmengen

Javascript um den Drag-Effekt der Login-Box zu erreichen

Detaillierte Erklärung basierend auf Event Bubbling, Event Capture und Event Delegation

So optimieren Sie den MySQL-Deduplizierungsvorgang maximal

Zusammenfassung der Fallstricke beim Importieren von OVA-Dateien in VMware

So installieren Sie mehrere mysql5.7.19 (tar.gz)-Dateien unter Linux