Die Rolle und Verwendungsdemonstration von Codekommentaren in der Frontend-Entwicklung

Beim Schreiben von Seiten sind Kommentare ein unverzichtbarer Bestandteil. Einerseits können Kommentare dazu dienen, die Struktur des Codes klarer zu erkennen, und andererseits sind sie auch förderlich für die Übergabe der Arbeit zwischen Kollegen. Natürlich sollten Codekommentare auch mit standardisiert werden. Deshalb werde ich heute mit Ihnen über Anmerkungen zum Frontend-Code sprechen. Freunde in Not können darauf verweisen.

1. Welchen Nutzen haben Codekommentare? nächste. Nur nicht so detailliert wie Pseudocode. Es wird jedoch auch auf die allgemeine Algorithmusidee zur Vervollständigung dieser Funktion hingewiesen. 2. Geben Sie denjenigen, die den Code lesen, eine Erläuterung. Beachten Sie, dass nur Sie selbst den Code betrachten. Lassen Sie Personen, die sich Ihren Code ansehen, Ihren Code schnell durchsuchen, ohne ihn jedes Mal Zeile für Zeile lesen zu müssen, um zu verstehen, was Sie geschrieben haben.

2. Codekommentarspezifikationen, befolgen Sie die folgenden Prinzipien

1. Kann den Lesern helfen, die Codelogik und -struktur besser zu verstehen 2 B. der Schreibmethode erklärt werden

3. Spezielle Markierungskommentare: wie TODO, FIXME und andere Markierungen mit besonderer Bedeutung

4. Dateikommentare: Einige Vorschriften verlangen, dass Kommentare in festem Format in die Kopfzeile der Datei geschrieben werden Datei, z. B. Autor, Protokoll und andere Informationen
5. Dokumentationskommentare: Einige Vorschriften verlangen, dass API-Klassen, Funktionen usw. Dokumentationskommentare verwenden (z. B. jsdoc-Stil)
6. Befolgen Sie einheitliche Stilspezifikationen, z bestimmte Leerzeichen und Leerzeilen, um die Lesbarkeit der Kommentare selbst sicherzustellen


3. So schreiben Sie Codekommentare

1. Kommentarinhalt -->;

<!-- html中要注释的内容 -->
在web页面中，最常见的注释就是这种了。我们在布局页面结构的时候，会添加少许的注释方便我们查找与记忆我们的想法。
那么在页面中除了这样的注释外，还有那些注释呢，这里我列举一些：
If条件不同版本浏览器注释列表：
<!--[if !IE]>除IE外都可识别<![endif]--> 
<!--[if IE]> 所有的IE可识别 <![endif]-->
<!--[if gt IE 5.0]> IE5.0以及IE5.0以上版本都可以识别 <![endif]--> 
<!--[if IE 6]> 仅IE6可识别 <![endif]--> 
<!--[if lt IE 6]> IE6以及IE6以下版本可识别 <![endif]--> 
<!--[if gte IE 6]> IE6以及IE6以上版本可识别 <![endif]--> 
<!--[if IE 7]> 仅IE7可识别 <![endif]--> 
<!--[if lt IE 7]> IE7以及IE7以下版本可识别 <![endif]--> 
<!--[if gte IE 7]> IE7以及IE7以上版本可识别 <![endif]-->

2. CSS-Code-Kommentare: /* Kommentarinhalt*/

Anders als das Kommentarformular in HTML haben Kommentare in CSS die Form /*Kommentare in css*/ . Es gibt keinen einzeiligen oder mehrzeiligen Kommentarinhalt.

/*.aa,.bb {
                height: 100px;
                margin: 1px;
                background: #ccc;
            }*/

3. JS-Codekommentare: //Kommentarinhalt; oder /* Kommentarinhalt*/,

Der Unterschied zu HTMLCSS besteht darin, dass Kommentare in JS einzeilig und mehrzeilig sind Unterscheidungen Es gibt viele Arten, die im Folgenden einzeln vorgestellt werden.

(1) // Zwei Schrägstriche stehen für einen einzeiligen Kommentar.

(2) Verwenden Sie /* * / Mehrzeilige Kommentare

//          function out(obj){
//              obj.innerHTML = "移出了";
//              obj.style.background = "#ccc";        
//          }

Zusammenfassung
: Frontend-Entwickler sollten ein tiefes Verständnis für den Zweck und die Prinzipien von Codekommentaren haben, die Kommentarkonventionen befolgen und sie in Verbindung verwenden Mit Tools können Kommentare zu einem guten Hilfsmittel für den Code werden. Verbessern Sie die Lesbarkeit und Wartbarkeit und verbessern Sie dadurch die Codequalität.

Das obige ist der detaillierte Inhalt vonDie Rolle und Verwendungsdemonstration von Codekommentaren in der Frontend-Entwicklung. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!