Τι είναι τα σχόλια Java και πώς να τα δημιουργήσετε

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

Τι είναι τα σχόλια Java;

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

Προκειμένου να αποφευχθούν παρεξηγήσεις και να δομηθεί ο κώδικας με μεγαλύτερη σαφήνεια, η Java δίνει στους χρήστες τη δυνατότητα να γράφουν σχόλια. Μπορείτε να χρησιμοποιήσετε σχόλια σε αυτή τη γλώσσα προγραμματισμού για να εξηγήσετε τη διαδικασία σκέψης, τους υπολογισμούς, τις μεθόδους, τις κλάσεις ή τις δομές σας. Όταν εσείς ή κάποιος άλλος εξετάσετε τον κώδικα αργότερα, τα σχόλια θα διευκολύνουν την εργασία με τον κώδικα.

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

Τα σχόλια Java διατίθενται σε τρεις διαφορετικές εκδόσεις: σχόλια μίας γραμμής, σχόλια μπλοκ (σχόλια πολλαπλών γραμμών) και σχόλια τεκμηρίωσης. Όλα τα σχόλια επισημαίνονται, ώστε να μην λαμβάνονται υπόψη κατά τη σύνταξη. Στις επόμενες ενότητες, θα σας δείξουμε πώς να δημιουργείτε σχόλια Java και πότε να χρησιμοποιείτε το καθένα.

Ποιοι τύποι σχολίων υπάρχουν στη Java;

Ανάλογα με το είδος των πληροφοριών που θέλετε να γράψετε, υπάρχουν τρία διαφορετικά είδη σχολίων διαθέσιμα στη Java. Αυτά είναι:

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

Αυτή είναι η απλούστερη επιλογή σχολίου. Αυτός ο τύπος σχολίου δημιουργείται χρησιμοποιώντας δύο διαδοχικές κάθετες (//) και δεν μπορεί να είναι μεγαλύτερος από μία γραμμή. Με τα σχόλια μίας γραμμής, δεν χρειάζεται να υποδείξετε ένα σημείο τερματισμού, καθώς αυτό επιτυγχάνεται αυτόματα στο τέλος της γραμμής. Αυτός ο τύπος σχολίων Java είναι κατάλληλος για σύντομα σχόλια που εξηγούν μια λειτουργία με λίγα λόγια.

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

Εάν οι εξηγήσεις σας πρέπει να είναι λίγο πιο εκτενείς, μπορείτε να χρησιμοποιήσετε σχόλια πολλαπλών γραμμών. Θεωρητικά, μπορούν να έχουν οποιοδήποτε μήκος. Είναι κατάλληλα για την συμπερίληψη εναλλακτικών γραμμών κώδικα που εξαιρούνται από τη σύνταξη ή για λεπτομερείς εξηγήσεις. Τα σχόλια πολλαπλών γραμμών εισάγονται με μια κάθετο και έναν αστερίσκο (/*). Όταν φτάσετε στο τέλος του σχολίου, απλά πληκτρολογήστε έναν αστερίσκο ακολουθούμενο από μια κάθετο (*/). Το κείμενο μεταξύ της εισαγωγικής κάθετου και της τελικής κάθετου αντιμετωπίζεται ως σχόλιο και δεν λαμβάνεται υπόψη κατά τη σύνταξη του κώδικα.

Σχόλια τεκμηρίωσης

Ενώ τα μονογραμμικά και πολυγραμμικά σχόλια μπορούν θεωρητικά να εισαχθούν οπουδήποτε στον πηγαίο κώδικα, τα σχόλια τεκμηρίωσης τοποθετούνται πάντα ακριβώς πριν από τις κλάσεις ή τις μεθόδους που περιγράφουν. Με τη βοήθεια εργαλείων, αυτά τα σχόλια διαβάζονται και συνοψίζονται σε τεκμηρίωση HTML. Χρησιμοποιούνται κυρίως για τη δημιουργία μεταδεδομένων για συγγραφείς και ορισμένους τύπους παραμέτρων. Αυτά επισημαίνονται με το σύμβολο @. Τα σχόλια τεκμηρίωσης εισάγονται με μια κάθετο και δύο αστερίσκους (/**) και τελειώνουν με έναν αστερίσκο και μια κάθετο (*/).

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

Για να κατανοήσουμε πώς λειτουργούν τα σχόλια Java στην πράξη, θα δούμε μερικά απλά παραδείγματα. Μπορείτε να τα δοκιμάσετε οι ίδιοι για να ελέγξετε το αποτέλεσμα. Ένα σχόλιο μιας γραμμής ξεκινά με δύο κάθετες γραμμές και μπορεί είτε να βρίσκεται σε δική του γραμμή είτε να τοποθετείται μετά από μια σειρά εντολών. **. Έτσι φαίνεται το σχόλιο σε δική του γραμμή:

// Example of a single-line comment
class Main {
	public static void main(String[] args) {
	// Here is the comment
	System.out.println("This is the text that will be output at the end.");
	}
}

Εάν χρησιμοποιήσετε την εντολή Java System.out.println, θα εμφανιστεί μόνο η πρόταση «Αυτό είναι το κείμενο που εμφανίζεται στο τέλος». Τα δύο σχόλια θα εμφανιστούν μόνο στον πηγαίο κώδικα.

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

// Example of a single-line comment
class Main {
public static void main(String[] args) {
System.out.println("This is the text that is output at the end."); // This is the comment.
	}
}

Η τοποθέτηση του σχολίου δεν αλλάζει το αποτέλεσμα.

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

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

/* In this example there is a multi-line comment.
It starts after the asterisk.
The actual instructions for the computer are under the comment.
This is the last line of this Java comment.
*/
class Main {
public static void main(String[] args) {
System.out.println("This is the text that will be output at the end.");
	}
}

Η έξοδος είναι «Αυτό είναι το κείμενο που θα εμφανιστεί στο τέλος.».

Δείτε πώς μπορείτε να εισάγετε το σχόλιο κάτω από τις οδηγίες:

// Example of a multi-line comment below the instructions
class Main {
public static void main(String[] args) {
System.out.println("This is the text that will be output at the end.");
/* In this example there is a multi-line comment.
It starts after the asterisk.
The actual instructions for the computer are above the comment.
This is the last line of this Java comment. */
	}
}

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

Σχόλια τεκμηρίωσης

Τα σχόλια τεκμηρίωσης λειτουργούν με παρόμοιο τρόπο με τα σχόλια μπλοκ, αλλά εισάγονται με μια κάθετο και δύο αστερίσκους. Αυτό επιτρέπει στα εργαλεία τεκμηρίωσης να χρησιμοποιούν τα σχόλια για τη δημιουργία τεκμηρίωσης. Εάν είναι απαραίτητο, μπορούν επίσης να περιέχουν ετικέτες HTML όπως <h1>, <p> ή <strong>.

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

e12e74fab6c42e595d29129172db8a19