Προσθέτοντας Σχόλια στον Java Code - dummies

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

/ * * Λίστα 3-6 στο "Java For Dummies, 6η Έκδοση" * * Πνευματικά δικαιώματα 2014 Wiley Publishing, Inc. * Όλα τα δικαιώματα διατηρούνται. * / / ** * Η κλάση Displayer εμφανίζει κείμενο * στην οθόνη του υπολογιστή. * * @author Barry Burd * @version 1. 0 10/24/13 * @ βλέπε java. lang. Σύστημα * / Public class Displayer {/ ** * Η κύρια μέθοδος είναι όπου αρχίζει η εκτέλεση του κώδικα. * * @param args (Δείτε το Κεφάλαιο 11.) * / δημόσιο static κενό main (String args []) {System. έξω. println ("αγαπώ την Java!"); //ΕΓΩ? Εσείς;}}

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

Η γλώσσα προγραμματισμού Java έχει τρία είδη σχολίων:

• Παραδοσιακά σχόλια: Οι πρώτες πέντε γραμμές της καταχώρισης αποτελούν ένα παραδοσιακό σχόλιο. Το σχόλιο αρχίζει με / * και τελειώνει με * /. Τα πάντα μεταξύ του ανοίγματος / * και του κλείστρου * / είναι μόνο για τα ανθρώπινα μάτια. Δεν υπάρχουν πληροφορίες για το "Java For Dummies, 6η Έκδοση" ή η Wiley Publishing, Inc. μεταφράζεται από τον μεταγλωττιστή.

  Η δεύτερη, τρίτη, τέταρτη και πέμπτη γραμμή στον κατάλογο 3-6 έχουν επιπλέον αστερίσκους (*). Ονομάζονται επιπλέον επειδή οι αστερίσκοι αυτοί δεν απαιτούνται όταν δημιουργείτε ένα σχόλιο. Απλώς κάνουν το σχόλιο να φαίνεται όμορφο.

• Σχόλια τέλους γραμμής: Το κείμενο // I? Εσείς? στην καταχώρηση υπάρχει σχόλιο στο τέλος της γραμμής . Ένα σχόλιο στο τέλος της γραμμής ξεκινά με δύο πτέρνες και πηγαίνει στο τέλος μιας γραμμής τύπου. Για άλλη μια φορά, ο μεταγλωττιστής δεν μεταφράζει το κείμενο μέσα στο σχόλιο στο τέλος της γραμμής.

• Τα σχόλια του Javadoc: Το σχόλιο javadoc αρχίζει με μια κάθετο και δύο αστερίσκους (/ **). Η καταχώριση έχει δύο σχόλια javadoc - ένα με το κείμενο Η κλάση Displayer … και μια άλλη με το κείμενο Η κύρια μέθοδος είναι όπου ….

  Ένα σχόλιο javadoc είναι ένα ιδιαίτερο είδος παραδοσιακού σχολιασμού. Ένα σχόλιο javadoc προορίζεται να διαβαστεί από ανθρώπους που ποτέ δεν βλέπουν ούτε καν τον κώδικα της Java. Αλλά αυτό δεν έχει νόημα. Πώς βλέπετε τα σχόλια του javadoc;

  Λοιπόν, ένα συγκεκριμένο πρόγραμμα που ονομάζεται javadoc (τι άλλο;) μπορεί να βρει όλα τα σχόλια javadoc στην λίστα και να μετατρέψει αυτά τα σχόλια σε μια όμορφη ιστοσελίδα. Αυτό το σχήμα δείχνει τη σελίδα.

  

Τα σχόλια του Javadoc είναι υπέροχα. Εδώ είναι αρκετά μεγάλα πράγματα γι 'αυτά:

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

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

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

• Ο προγραμματιστής δεν δημιουργεί δύο ξεχωριστά πράγματα - κάποιο κώδικα Java εδώ και κάποια τεκμηρίωση σχετικά με τον κώδικα εκεί. Αντ 'αυτού, ο προγραμματιστής δημιουργεί ένα κομμάτι κώδικα Java και ενσωματώνει την τεκμηρίωση (με τη μορφή σχολίων javadoc) ακριβώς μέσα στον κώδικα.

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