Vertiefendes Verständnis der JS-Code-Annotationsmethoden und Code-Annotationsspezifikationen

Um die Lesbarkeit des Codes zu verbessern, ist es häufig erforderlich, dem Code Kommentare hinzuzufügen. In diesem Artikel erfahren Sie, wie Sie JS-Code und die Spezifikationen von JS-Code-Kommentaren kommentieren Ich kann darauf verweisen. Ich hoffe, das hilft!

Kommentare sind ein wesentlicher Bestandteil des Codes und ein komplettes Programm muss kommentiert werden. Kommentare helfen Ihnen nicht nur, das Projekt zu aktualisieren und zu ändern, sondern helfen auch anderen, zu erfahren, was Sie geschrieben haben, wenn sie Ihr Projekt erhalten.

1. JavaScript-Code-Kommentarmethode

JavaScript führt den Code im Kommentar nicht aus. Zeilenkommentare.

1. Einzeilige Kommentare

Einzeilige Kommentare beginnen mit //, fügen Sie nach // ein Leerzeichen ein und schreiben Sie dann den Inhalt des Kommentars um die Funktion des aktuellen Codes zu beschreiben und den Code zu erklären usw.

Codebeispiel: Kommentieren Sie eine einzelne Zeile des document.write("string is:"+str)-Codes, ohne dass sie auf der Seite angezeigt wird

<script type="text/javascript">
  function myFunction(){
   var animal = ["dog", "cat", "elephant", "tiger"];
   var str=animal.toString();
   document.write("类型是："+typeof(str));  
   //document.write("字符串是:"+str)
  }  
 </script>

Rendering vor dem Kommentar:

Rendering nach Kommentar:

2 Mehrzeilige Kommentare beginnen mit /*. , Beenden Sie mit */, aber versuchen Sie, in Ihrer Arbeit einzeilige Kommentare anstelle von mehrzeiligen Kommentaren zu verwenden. Auch wenn die Kommentare mehrere Zeilen erfordern, sollten sie mit einzeiligen Kommentaren vervollständigt werden -Zeilenkommentare für Funktionskommentare.

Codebeispiel:

<script>
/*
下面的这些代码会输出
一个标题和一个段落
并将代表主页的开始
*/
document.getElementById("myH1").innerHTML="欢迎来到菜鸟教程";
document.getElementById("myP").innerHTML="这是一个段落。";
</script>

2. Spezifikationen für JS-Codekommentare

Wenn dies nicht der Fall ist, sollte ein guter Codekommentar erstellt werden Fügen Sie bei Bedarf keine Kommentare hinzu. Schreiben Sie diese ausführlich, damit andere verstehen, was Sie meinen, und versuchen Sie, die Klarheit und Lesbarkeit des Codes zu verbessern. Folgende Punkte sollten bei der Arbeit erreicht werden:

1. Im logischen Code sollten Codekommentare mehr als 20 % betragen

2 Datei. Header

3. Beim Kommentieren von Klassen und Schnittstellen müssen die Kommentare vor der Klasse und nach den Schlüsselwörtern „using“ oder „package“ platziert werden

4 , Kommentare Es muss über Klassenattribute, öffentliche und geschützte Methoden geschrieben werden. Verwenden Sie einfach //Comments, der kommentierte Code muss ausgerichtet werden

5. Kommentare müssen vor dem kommentierten Code platziert werden, in separaten Zeilen geschrieben werden und keine Leerzeilen in der Mitte lassen

6. Fügen Sie sie nicht in Kommentare ein. Verwenden Sie Abkürzungen. Wenn Sie Abkürzungen verwenden möchten, müssen Sie die erforderlichen Erklärungen für die Abkürzungen bereitstellen.

7. Bei der Kommentierung des Inhalts von Mitgliedsvariablen müssen die Bedeutung, der Zweck und die Funktion berücksichtigt werden der Mitgliedsvariablen und wo sie verwendet werden können, verwenden Sie //, um Kommentare mit dem kommentierten Code auszurichten.

Kurz gesagt, jeder Programmierer sollte eine gute Angewohnheit entwickeln, Kommentare zu schreiben, was nicht nur gelingt Dies erleichtert Ihnen das Lesen und Ändern des Codes, macht es aber auch für andere einfacher, Ihren Code zu verstehen und zu warten.

Das Obige stellt die Annotationsmethode von JS-Code und die Annotationsspezifikationen von JS-Code vor. Weitere verwandte Tutorials finden Sie unter

JavaScript-Video-Tutorial

Das obige ist der detaillierte Inhalt vonVertiefendes Verständnis der JS-Code-Annotationsmethoden und Code-Annotationsspezifikationen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!