Συμβουλές

Χρήση σχολίων σε Ruby

Χρήση σχολίων σε Ruby

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

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

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

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

Είναι σημαντικό να προσέξετε να μην χρησιμοποιήσετε πάρα πολλά σχόλια και να είστε βέβαιοι ότι τα σχόλια που περιέχονται στο αρχείο είναι χρήσιμα και χρήσιμα σε άλλους προγραμματιστές.

Το Σεμπάνγκ

Θα παρατηρήσετε ότι όλα τα προγράμματα Ruby ξεκινούν με ένα σχόλιο που αρχίζει με #!. Αυτό ονομάζεται a δουλεία και χρησιμοποιείται σε συστήματα Linux, Unix και OS X.

Όταν εκτελείτε ένα σενάριο Ruby, το κέλυφος (όπως bash σε Linux ή OS X) θα ψάξει για ένα shebang στην πρώτη γραμμή του αρχείου. Το κέλυφος θα χρησιμοποιήσει στη συνέχεια το shebang για να βρει τον ερμηνευτή του Ruby και να εκτελέσει το σενάριο.

Το προτιμώμενο ρουμπίνι shebang είναι #! / usr / bin / env ruby, αν και μπορείτε επίσης να δείτε #! / usr / bin / ruby ή #! / usr / local / bin / ruby.

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

Το σχόλιο μιας γραμμής Ruby ξεκινά με το # χαρακτήρα και τελειώνει στο τέλος της γραμμής. Οποιοιδήποτε χαρακτήρες από το # χαρακτήρας στο τέλος της γραμμής αγνοούνται εντελώς από τον διερμηνέα Ruby.

ο # ο χαρακτήρας δεν πρέπει υποχρεωτικά να εμφανίζεται στην αρχή της γραμμής. μπορεί να συμβεί οπουδήποτε.

Το παρακάτω παράδειγμα επεξηγεί μερικές χρήσεις των σχολίων.

#! / usr / bin / env ruby

# Η γραμμή αυτή αγνοείται από τον διερμηνέα Ruby

# Αυτή η μέθοδος εκτυπώνει το άθροισμα των επιχειρημάτων της

def suma (a, b)

βάζει a + b

τέλος

sum (10,20) # Εκτυπώστε το άθροισμα των 10 και 20

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

Αν και συχνά ξεχνιέται από πολλούς προγραμματιστές Ruby, ο Ruby έχει σχόλια πολλών γραμμών. Ένα σχόλιο πολλών γραμμών αρχίζει με το = έναρξη token και τελειώνει με το = τέλος ένδειξη.

Αυτά τα μάρκες θα πρέπει να ξεκινούν από την αρχή της γραμμής και να είναι το μόνο πράγμα στη γραμμή. Οτιδήποτε ανάμεσα σε αυτά τα δύο μάρκες αγνοείται από τον ερμηνευτή του Ruby.

#! / usr / bin / env ruby

= έναρξη

Μεταξύ = έναρξη και = τέλος, οποιοσδήποτε αριθμός

γραμμών μπορεί να γραφτεί. Ολα αυτά

οι γραμμές αγνοούνται από τον ερμηνευτή του Ruby.

= τέλος

θέτει "Γεια σας κόσμο!"

Σε αυτό το παράδειγμα, ο κώδικας θα εκτελεστεί ως Γειά σου Κόσμε!