Ein guter Codierungsstil kann uns helfen, bei der Erstellung von Webseiten klare Vorstellungen zu haben, und die Codekommentare enthalten auch einige kleine Kenntnisse.
Ich habe die Standards zum Schreiben von Anmerkungen zusammengefasst, die ich in meiner Arbeit verwendet habe. Tatsächlich gibt es keinen technischen Inhalt. Die Hauptsache ist, auf die Standards zu achten, was die einheitliche Produktionsmethode erleichtert und die Wartung erleichtert.
Diese Erfahrungen umfassen vier Teile: „Regionskommentare“, „Einzeilige Kommentare“, „Kommentarebenen“ und „Unterstützte Kommentare“. Die von den meisten Freunden verwendete Methode zur Bereichsanmerkung beginnt mit „Anmerkungsinhalt“ oder „Anmerkungsinhaltsende“, „Start“ oder „Ende“ usw. Im Vergleich dazu kann es schneller sein, mit „S“ oder „E“ zu beginnen Verwenden Sie beispielsweise einfach den Start- oder Endkommentar einmal, kopieren Sie ihn und ändern Sie das „S“ oder „E“, um den Kommentar im Bereich schnell zu vervollständigen.
In der Praxis 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 Anfang und Ende der Bereichsbezeichnung geschrieben und mit „S“ versehen „ oder
„
E“ beginnt und gibt den Anfang oder das Ende der Bereichsanmerkung an.Beispiel:
<!--=S Kommentarinhalt-->
<div>
...
</div>
<!--=E Kommentarinhalt-->
/*=S Kommentarinhalt*/
.Klasse{
...
}
.Klasse{
...
}
/*=E Kommentarinhalt*/
Einzeilige Kommentarkommentarinformationen
sollten in den Inhaltsbereich geschrieben werden, der kommentiert werden muss.
Beispiel:
<div>
<!--Kommentarinhalt-->
...
</div>
.class{
/*Kommentarinhalt*/
...
}
Annotationsebene
In der Modulproduktion kann es Bereiche innerhalb von Bereichen geben. Um die Ebenen zwischen Bereichen besser unterscheiden zu können, wird das Konzept der Annotationsebene eingeführt. Das Gleichheitszeichen vor dem Bereichskommentar gibt die Ebene des aktuellen Kommentars an.
Beispiel:
<!--=S Kommentarinhalt-->
...
<!--==S Kommentarinhalt-->
...
<!--===S Kommentarinhalt-->
...
<!--===E Kommentarinhalt-->
...
<!--==E Kommentarinhalt-->
...
<!--=E Kommentarinhalt-->
/*=S Kommentarinhalt*/
...
/*==S Kommentarinhalt*/
...
/*===S Kommentarinhalt*/
...
/*===E Kommentarinhalt*/
...
/*==E Kommentarinhalt*/
...
/*=E Kommentarinhalt*/
Hilft beim Kommentieren
von Identifikationsinformationen wie Änderungszeit und hinzugefügtem Modifikator, wenn diese von Nicht-Autoren gepflegt werden. Fügen Sie den Modifikator und die Änderungszeit sowie andere Informationen basierend auf dem Bereichskommentar oder dem einzeiligen Kommentar hinzu.
Beispiel (Regionskommentar):
<!--==S Kommentarinhalt [Modifikator und Änderungszeit]-->
<div>
...
</div>
<!--==E Kommentarinhalt [Modifikator und Änderungszeit]-->
/*=S Kommentarinhalt [Modifikator und Änderungszeit]*/
.Klasse{
...
}
.Klasse{
...
}
/*=E Kommentarinhalt [Modifikator und Änderungszeit]*/
Beispiel (einzeiliger Kommentar):
<div>
<!-- Kommentarinhalt [Modifikator und Änderungszeit]-->
...
</div>
.class{
/*Kommentarinhalt [Modifikator und Änderungszeit]*/
...
}