In diesem Artikel erfahren Sie mehr über Kotlin-Kommentare und warum und wie Sie sie verwenden.
Bei der Programmierung sind Kommentare Teil des Programms, das für Sie und Ihre Programmierkollegen bestimmt ist, um den Code zu verstehen. Sie werden vom Kotlin-Compiler (Kompiler) komplett ignoriert.
Ähnlich wie bei Java gibt es in Kotlin zwei Arten von Kommentaren
/*… *///… .
Traditioneller Kommentar / *… * /
Dies ist ein mehrzeiliger Kommentar, der sich über mehrere Zeilen erstrecken kann. Der Kotlin-Compiler ignoriert alles von /*bis */. Beispielsweise,
/* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )
Der Traditionskommentar wird auch verwendet, um Kotlin-Code (KDoc) mit einer kleinen Variation zu dokumentieren. Die KDoc-Kommentare beginnen mit /**und enden mit */.
Zeilenende Kommentar //
Der Compiler ignoriert alles //bis zum Ende der Zeile. Beispielsweise,
// Kotlin Hello World Programm Spaß main (args: Array) (println ("Hello, World!") // Gibt Hello, World! Auf dem Bildschirm aus)
Das obige Programm enthält zwei Kommentare zum Zeilenende:
// Kotlin Hallo Weltprogramm
und
// gibt Hallo aus, Welt! auf dem Bildschirm
Verwenden Sie Kommentare richtig
Kommentare sollten nicht den Ersatz für eine Möglichkeit darstellen, schlecht geschriebenen Code auf Englisch zu erklären. Schreiben Sie gut strukturierten und lesbaren Code und verwenden Sie dann Kommentare.
Einige glauben, dass Code sich selbst dokumentieren und Kommentare knapp sein sollten. Ich muss dem jedoch völlig widersprechen (es ist meine persönliche Meinung). Es ist nichts Falsches daran, Kommentare zu verwenden, um komplexe Algorithmen, Regex oder Szenarien zu erklären, in denen Sie eine Technik der anderen vorgezogen haben (zur späteren Bezugnahme), um das Problem zu lösen.
Verwenden Sie in den meisten Fällen Kommentare, um zu erklären, warum und nicht wie, und Sie können loslegen.
