Kommentare

F: Was macht ein Programmierer, wenn er Dokumentation für seinen Code schreiben muss?

A: Er schreibt sie in eine Word-Datei.

F: Was macht ein guter Programmierer, wenn er Dokumentation für seinen Code schreiben muss?

A: Er verwendet Kommentare.

Lassen Sie uns Sie in einen guten Programmierer verwandeln und Ihnen beibringen, wie Sie Kommentare in Ihrem Code verwenden. Aber zuerst wollen wir herausfinden, was sie sind:

In TypeScript gibt es zwei Arten von Kommentaren:

Wir können eine ganze Zeile mit // auskommentieren;
Wir können auch einen Codeblock, der sich über mehrere Zeilen erstreckt, oder ein einzeiliges Codefragment mit /* code */ auskommentieren.

Schauen wir uns ein Beispiel an, bei dem wir einige Zeilen auskommentieren und dort Kommentare schreiben müssen. Ich wiederhole, der Compiler wird die auskommentierten Codefragmente nicht ausführen oder auch nur betrachten, daher können wir dort alles schreiben (außer schlechten Wörtern; meine Mutter schimpft mit mir, wenn ich solche schreibe).


              12345678
            
console.log("Hello world!") 
// This code performs output of information to the screen.
let word : string = 'c<>definity' 
console.log(`Hello ${word}!`)
/*This code creates a variable of type string 
and uses it for output to the screen. 
We use this variable with the required syntax 
and successfully display text on the screen with the variable. */

Wie Sie im obigen Code sehen können, haben wir verschiedene Textfragmente auskommentiert. In Kommentaren schreiben wir Erklärungen darüber, was im Code passiert und was bestimmte Zeilen tun. Beachten Sie, dass wir beim Auskommentieren mehrerer Zeilen eine andere Kommentarsyntax verwenden. (/* */) Nach // wird alles rechts von den Zeichen auskommentiert.

Wir können auch Codefragmente auskommentieren. Zum Beispiel, wenn wir einen Fehler in einer bestimmten Zeile vermuten, können wir diese Zeile auskommentieren und den Code erneut ausführen, um diese Zeile auf Fehler zu überprüfen.


              123
            
//var str = 'Hello World";
var num = 132;
console.log(num/* - str*/);

Oben haben wir Codefragmente auskommentiert, in denen wir Fehler vermuten, indem wir verschiedene Arten von Kommentaren verwenden. Persönlich identifiziere ich oft fehleranfällige Bereiche im Code mit dieser Methode und ich empfehle, dass Sie dasselbe tun. Es ist eine nützliche Fähigkeit für einen guten Programmierer.

Vergessen Sie auch nicht, Dokumentation für Ihren Code zu schreiben. Es ist, als ob Sie eine Flasche Wasser neben Ihr Bett stellen, nachdem Sie nachts getrunken haben.

War alles klar?

Danke für Ihr Feedback!

Abschnitt 1. Kapitel 6