Σχόλια Kotlin

Σε αυτό το άρθρο, θα μάθετε για τα σχόλια του Kotlin και γιατί και πώς να τα χρησιμοποιήσετε.

Στον προγραμματισμό, τα σχόλια αποτελούν μέρος του προγράμματος που προορίζεται για εσάς και τους συναδέλφους σας προγραμματιστές να κατανοήσετε τον κώδικα. Αγνοούνται εντελώς από τον μεταγλωττιστή Kotlin (Kompiler).

Παρόμοια όπως η Java, υπάρχουν δύο τύποι σχολίων στο Kotlin

  • /*… */
  • //… .

Παραδοσιακό σχόλιο / *… * /

Αυτό είναι ένα πολύπλευρο σχόλιο που μπορεί να εκτείνεται σε πολλές γραμμές. Ο compiler Kotlin αγνοεί τα πάντα, από /*έως */. Για παράδειγμα,

 /* This is a multi-line comment. * The problem prints "Hello, World!" to the standard output. */ fun main(args: Array) ( println("Hello, World!") )

Το σχόλιο της παράδοσης χρησιμοποιείται επίσης για την τεκμηρίωση του κώδικα Kotlin (KDoc) με μικρή παραλλαγή. Τα σχόλια του KDoc ξεκινούν με /**και τελειώνουν με */.

Σχόλιο τέλους γραμμής //

Ο μεταγλωττιστής αγνοεί τα πάντα από //το τέλος της γραμμής. Για παράδειγμα,

 // Kotlin Hello World Program fun main (args: Array) (println ("Hello, World!") // εξόδους Hello, World! Στην οθόνη)

Το παραπάνω πρόγραμμα περιέχει δύο σχόλια στο τέλος της γραμμής:

 // Πρόγραμμα Kotlin Hello World

και

// έξοδοι Γεια, Κόσμος! στην οθόνη

Χρησιμοποιήστε σχόλια με τον σωστό τρόπο

Τα σχόλια δεν πρέπει να είναι το υποκατάστατο ενός τρόπου εξήγησης του κακώς γραμμένου κώδικα στα Αγγλικά. Γράψτε καλά δομημένο και αναγνώσιμο κώδικα και, στη συνέχεια, χρησιμοποιήστε σχόλια.

Ορισμένοι πιστεύουν ότι ο κώδικας πρέπει να είναι αυτο-τεκμηρίωση και τα σχόλια πρέπει να είναι λιγοστά Ωστόσο, πρέπει να διαφωνήσω πλήρως με αυτό (Είναι η προσωπική μου γνώμη). Δεν υπάρχει τίποτα λάθος με τη χρήση σχολίων για την εξήγηση σύνθετων αλγορίθμων, regex ή σεναρίων όπου έχετε επιλέξει μια τεχνική σε σχέση με την άλλη (για μελλοντική αναφορά) για την επίλυση του προβλήματος.

Στις περισσότερες περιπτώσεις, χρησιμοποιήστε σχόλια για να εξηγήσετε «γιατί» αντί για «πώς» και είστε καλοί να πάτε.

ενδιαφέροντα άρθρα...