Παράδειγμα προσθήκης σχολίων σε 15 γλώσσες προγραμματισμού

Ας μάθουμε τι είναι τα σχόλια και γιατί είναι σημαντικά στον προγραμματισμό.

Καλύπτουμε επίσης δύο κοινούς τύπους σχολίων και πώς να τα γράφουμε σε 15 διαφορετικές γλώσσες προγραμματισμού.

Τι είναι τα σχόλια στον προγραμματισμό;

Τα σχόλια με απλούς όρους είναι κομμάτια κειμένου που δεν θα είναι ορατά στους τελικούς χρήστες και προορίζονται για την αναφορά ατόμων που γράφουν κώδικα.

Λίγο πιο επίσημα, ένα σχόλιο είναι μια περιγραφή ενός προγράμματος σχετικά με τον τρόπο λειτουργίας του σε μια απλή αναγνώσιμη μορφή. Αυτά χρησιμοποιούνται συνήθως σε μέρη όπου πρέπει να παρέχεται κάποια πρόσθετη σαφήνεια στον προγραμματιστή που διαβάζει τον κώδικα. Έτσι, αυτό βοηθά στη βελτίωση της αναγνωσιμότητας του κώδικα και μειώνει τον χρόνο και την επικοινωνία που θα απαιτούνταν για τη μεταφορά γνώσης.

Ο μεταγλωττιστής/διερμηνέας απλώς αγνοεί τα σχόλια στον κώδικά σας, με αποτέλεσμα να μην επηρεάζει την τελική έξοδο του προγράμματός σας. Έτσι, με λίγα λόγια τα σχόλια είναι σαν μια απλή αναγνώσιμη εξήγηση για ορισμένα κομμάτια κώδικα.

Κοινοί τύποι σχολίων

Οι περισσότερες γλώσσες προγραμματισμού υποστηρίζουν 2 τύπους σχολίων.

  • Σχόλιο μονής γραμμής
  • Σχόλιο πολλαπλών γραμμών / Αποκλεισμός σχολίων

Όπως υποδηλώνει το όνομα τα σχόλια μιας γραμμής είναι χρήσιμα όταν χρειάζεται να προσθέσετε μικρό κείμενο μιας γραμμής, π.χ. μια συγκεκριμένη συνθήκη, μια σταθερή τιμή που χρειάζεται μια μικρή περιγραφή. Ενώ οι πολλαπλές γραμμές λειτουργούν καλύτερα όταν έχουμε να προσθέσουμε μεγαλύτερο όγκο πληροφοριών όπως μια περιγραφή για μια λειτουργία και πώς μπορεί κανείς να τη χρησιμοποιήσει κ.λπ.

  Πώς να αποθηκεύσετε το ιστορικό αρχείου του Photoshop σε ένα αρχείο κειμένου

Υπάρχουν κάποιοι άλλοι τύποι σχολίων, όπως τα σχόλια εγγράφων, αλλά αυτό δεν εμπίπτει στο πεδίο εφαρμογής αυτού του άρθρου.

Γιατί να προσθέσετε σχόλια;

«Οποιοσδήποτε ανόητος μπορεί να γράψει κώδικα που μπορεί να καταλάβει ένας υπολογιστής. Οι καλοί προγραμματιστές γράφουν κώδικα που μπορούν να κατανοήσουν οι άνθρωποι». – Μάρτιν Φάουλερ

Το κύριο πλεονέκτημα της προσθήκης σχολίων είναι η βελτιωμένη αναγνωσιμότητα και η καλύτερη κατανόηση του προγράμματος. Εκτός από αυτό, ορισμένα άλλα πλεονεκτήματα περιλαμβάνουν:

  • Τα σχόλια διευκολύνουν τους συνομηλίκους σας και ακόμη και άλλους προγραμματιστές να κατανοήσουν τη λογική χωρίς να διαβάζουν μεγάλες τεκμηριώσεις.
  • Μειωμένη επικοινωνία μεταξύ προγραμματιστών για μικρές αμφιβολίες
  • Τα σχόλια αγνοούνται από τον μεταγλωττιστή/διερμηνέα.
  • Για λογισμικό ανοιχτού κώδικα, αυτά είναι απαραίτητα, καθώς δεν θα είστε εκεί για να εξηγήσετε κάθε λειτουργία σε εκατομμύρια προγραμματιστές που θέλουν να χρησιμοποιήσουν το συγκεκριμένο πρόγραμμα.

Σχόλια σε πολλές γλώσσες

Φοβερό, τώρα που μάθαμε για τα σχόλια και γιατί είναι χρήσιμα. Ας εξερευνήσουμε πώς μπορούμε να προσθέσουμε σχόλια σε διαφορετικές γλώσσες προγραμματισμού.

  Πώς να επιλέξετε το καλύτερο

Σχόλιο μονής γραμμής

// This is a single line comment in C/C++

Σχόλιο πολλαπλών γραμμών

/* This is slightly long
multi line comment in C/C++ */

Σχόλιο μονής γραμμής

# This is a single line comment in Python

Σχόλιο πολλαπλών γραμμών

# This is slightly long
# multi line comment in Python

Σχόλιο μονής γραμμής

// This is a single line comment in Java

Σχόλιο πολλαπλών γραμμών

/* This is slightly long
multi line comment in Java */

Σχόλιο μονής γραμμής

# This is a single line comment in Ruby

Σχόλιο πολλαπλών γραμμών

=begin 
This is slightly long
multi line comment in Ruby
=end

Σχόλιο μονής γραμμής

// This is a single line comment in Golang

Σχόλιο πολλαπλών γραμμών

/* This is slightly long
multi line comment in Golang */

Σχόλιο μονής γραμμής

– – This is a single line comment in Haskell

Σχόλιο πολλαπλών γραμμών

{- This is slightly long
multi line comment in Haskell -}

Σχόλιο μονής γραμμής

// This is a single line comment in Rust

Σχόλιο πολλαπλών γραμμών

/* This is slightly long
multi line comment in Rust */

Σχόλιο μονής γραμμής

<!--  This is a single line comment in HTML -->

Σχόλιο πολλαπλών γραμμών

<!-- This is slightly long
multi line comment in HTML -->

Σχόλιο μονής γραμμής

/* This is a single line comment in CSS */

Σχόλιο πολλαπλών γραμμών

/* This is slightly long
multi line comment in CSS */

Σχόλιο μονής γραμμής

// This is a single line comment in Javascript

Σχόλιο πολλαπλών γραμμών

/* This is slightly long
multi line comment in Javascript */

Σχόλιο μονής γραμμής

# This is a single line comment in R programming language

Σχόλιο πολλαπλών γραμμών

Το R δεν υποστηρίζει σχόλια πολλαπλών γραμμών.

Σχόλιο μονής γραμμής

% This is a single line comment in Erlang

Σχόλιο πολλαπλών γραμμών

Το R δεν υποστηρίζει σχόλια πολλαπλών γραμμών.

Σχόλιο μονής γραμμής

// This is a single line comment in PHP

Σχόλιο πολλαπλών γραμμών

/* This is slightly long
multi line comment in PHP */

Σχόλιο μονής γραμμής

# This is a single line comment in Perl

Σχόλιο πολλαπλών γραμμών

=begin 
This is slightly long
multi line comment in Perl
=end

Σχόλιο μονής γραμμής

// This is a single line comment in Kotlin

Σχόλιο πολλαπλών γραμμών

/* This is slightly long
multi line comment in Kotlin */

συμπέρασμα

Το σεμινάριο κάλυψε βασικά στοιχεία σχετικά με τα σχόλια και 2 κοινούς τύπους – Μονής και πολλαπλής γραμμής. Προσπάθησα επίσης να καλύψω γιατί τα σχόλια είναι χρήσιμα και πρέπει να τα γράφει κανείς όταν χρειάζεται. Ελπίζω να έμαθες κάτι νέο!

Συνεχίστε την εξερεύνηση. Συνέχισε να μαθαίνεις! 👨‍💻