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

Beispielcode einer benutzerdefinierten Vue-Komponente zur Implementierung bidirektionaler V-Model-Bindungsdaten

Standards zum Schreiben von Codekommentaren bei der Webseitenerstellung

Beispielcode einer benutzerdefinierten Vue-Komponente zur Implementierung bidirektionaler V-Model-Bindungsdaten

Warum DOCTYPE HTML verwenden?

Ursachen und Lösungen für langsame MySQL-Abfragen

Praxis der Implementierung einer benutzerdefinierten Suchleiste und des Löschens von Suchereignissen in Avue

Tutorial und Praxis zu den virtuellen Speichereinstellungen unter Linux

So richten Sie virtuelle Verzeichnisse ein und konfigurieren virtuelle Pfade in Tomcat 7.0

Beispielcode für Text-Origami-Effekt mit CSS3

Das ausführliche Tutorial zum Herunterladen und Installieren von MySQL 8.0.15 ist für Anfänger ein Muss!

Architektur und Komponentenbeschreibung der privaten Docker-Bibliothek Harbor

Lösen Sie das Problem verstümmelter Daten bei der MySQL-Datenbankmigration

Artikel empfehlen

MySql 8.0.11 Installations- und Konfigurationstutorial

So verwenden Sie Node.js, um festzustellen, ob ein PNG-Bild transparente Pixel hat

Unterschied zwischen MySQL Btree-Index und Hash-Index

Schritte zum Kauf eines Cloud-Servers und zur Installation des Pagoda Panels in der Alibaba Cloud

Informationen zur Installation von Homebrew auf dem Mac

Detaillierte Erläuterung der ersten Erfahrungen mit Vue3.0 + TypeScript + Vite

Erklärung des Konzepts und der Verwendung von Like in MySQL

Fügen Sie eine schwebende Eingabeaufforderung für das Kopfzeilensymbol in der ElementUI-Tabelle hinzu

Eine kurze Diskussion über die Rolle leerer HTML-Links

So finden Sie Websites mit SQL-Injection (unbedingt lesen)

Erstellen Sie eine virtuelle Umgebung mit venv in Python3 in Ubuntu

Was sind die Unterschiede zwischen SQL und MySQL

Webdatenspeicherung: Cookie, UserData, SessionStorage, WebSqlDatabase

Spielen Sie mit der Connect-Funktion mit Timeout in Linux

Detailliertes Beispiel für MySQL ähnlich dem Schreiben von Oracle Rownum