Τι είναι τα Σχόλια HTML και πώς χρησιμοποιούνται
aΌταν προβάλλετε μια ιστοσελίδα σε ένα πρόγραμμα περιήγησης, βλέπετε μια οπτική αναπαράσταση του τι εμφανίζεται αυτό το λογισμικό (το πρόγραμμα περιήγησης ιστού) με βάση τον κώδικα μιας συγκεκριμένης ιστοσελίδας. Αν δείτε αυτόν τον πηγαίο κώδικα της ιστοσελίδας, θα δείτε ένα έγγραφο που αποτελείται από διάφορα στοιχεία HTML, συμπεριλαμβανομένων παραγράφων, επικεφαλίδων, λιστών, συνδέσμων, εικόνων και άλλων. Όλα αυτά τα στοιχεία παρέχονται από το πρόγραμμα περιήγησης στην οθόνη του επισκέπτη ως τμήμα της προβολής του ιστότοπου. Ένα πράγμα που μπορείτε να βρείτε σε κώδικα HTML που δεν εμφανίζεται στην οθόνη ενός ατόμου είναι αυτά που είναι γνωστά ως "σχόλια HTML".
Τι είναι ένα σχόλιο;
Ένα σχόλιο είναι μια συμβολοσειρά κώδικα μέσα σε HTML, XML ή CSS που δεν εμφανίζεται ή δεν ενεργεί από το πρόγραμμα περιήγησης ή τον αναλυτή. Είναι απλά γραμμένο στον κώδικα για να παρέχει πληροφορίες σχετικά με αυτόν τον κώδικα ή άλλα σχόλια από τους προγραμματιστές κώδικα.
Οι περισσότερες γλώσσες προγραμματισμού έχουν παρατηρήσεις, χρησιμοποιούνται συνήθως από τον προγραμματιστή του κώδικα για ένα ή και περισσότερα από ένα, για τους εξής λόγους:
- Περιγράψτε και εξηγήστε περίπλοκο κώδικα σε κάποιον που μπορεί να χρειαστεί να εργαστεί σε αυτό στο μέλλον - συμπεριλαμβανομένου και του εαυτού του! Μπορούν να επανέλθουν στον κώδικα 3 ή 6 από 12 μήνες ή περισσότερο αργότερα και να μην θυμούνται γιατί έκαναν κάτι με κάποιο τρόπο. Τα σχόλια μπορούν να βοηθήσουν να απαντήσουν στις ερωτήσεις τους και να τους υπενθυμίσουν πού ήταν το μυαλό τους κατά την πρώτη ανάπτυξη αυτής της σελίδας.
- Παρέχετε λεπτομέρειες σχετικά με τον χρόνο επεξεργασίας ή ελέγχου του κώδικα. Αυτό μπορεί να είναι χρήσιμη πληροφορία και να δράσει κάπως σαν ένα αρχείο καταγραφής ανάπτυξης όταν πραγματοποιήθηκε τελευταία εργασία σε έναν ιστότοπο.
- Καταργήστε τμήματα του κώδικα, αλλά αφήστε τα διαθέσιμα για μεταγενέστερη χρήση. Αυτό γίνεται συχνά κατά τη διάρκεια δοκιμών και σφαλμάτων ιστότοπου. Εάν αντιμετωπίζετε κάποιο πρόβλημα σε έναν ιστότοπο και δεν είστε σίγουροι για αυτό που το προκαλεί, μπορείτε να σχολιάζετε τις ενότητες μία φορά τη φορά στην quarentine και να εντοπίζετε το πρόβλημα και, στη συνέχεια, να επεξεργαστείτε μια λύση για τα προβλήματα που αντιμετωπίζετε.
- Συζήτηση με άλλους προγραμματιστές που εργάζονται στον κώδικα. Αυτό θα μπορούσε να γίνει κατά τη διάρκεια της ανάπτυξης ως ένας τρόπος για να μοιραστείτε λεπτομέρειες με άλλους που εργάζονται στον κώδικα ταυτόχρονα. Αν αυτά τα σχόλια είναι καθαρά συζητήσεις για την ανάπτυξη, είναι καλύτερο να τα αφαιρέσετε από τον κώδικα πριν ξεκινήσει ένας ιστότοπος.
Παραδοσιακά, τα σχόλια σε HTML χρησιμοποιούνται για σχεδόν οποιαδήποτε στοιχεία, από εξηγήσεις περίπλοκων τραπεζικών δομών μέχρι ενημερωτικές παρατηρήσεις για το περιεχόμενο της ίδιας της σελίδας. Επειδή τα σχόλια δεν εμφανίζονται σε ένα πρόγραμμα περιήγησης, μπορείτε να τα προσθέσετε οπουδήποτε στο HTML και να μην ανησυχείτε για το τι θα κάνει όταν ο ιστότοπος προβάλλεται από έναν πελάτη.
Πώς να γράψετε σχόλια
Η σύνταξη σχολίων σε HTML, XHTML και XML είναι πολύ εύκολη. Απλά περιβάλλετε το κείμενο που θέλετε να σχολιάσετε με τα εξής:
και ->Όπως μπορείτε να δείτε, αυτά τα σχόλια αρχίζουν με ένα "λιγότερο από το σύμβολο", συν ένα σημείο αναφωνίας και δύο παύλες. Το σχόλιο τελειώνει με δύο περισσότερες παύλες και ένα σύμβολο μεγαλύτερο από: Μεταξύ αυτών των χαρακτήρων μπορείτε να γράψετε ό, τι θέλετε να δημιουργήσετε το σώμα του σχολίου.
Στο CSS, είναι λίγο διαφορετικό, χρησιμοποιώντας τα σχόλια του κώδικα C αντί για το HTML. Ξεκινάτε με μια προς τα εμπρός κάθετο και ακολουθεί ένας αστερίσκος. Τερματίζετε το σχόλιο με το αντίστροφο, έναν αστερίσκο που ακολουθείται από μια προς τα εμπρός κάθετο.
/ * σχολίασε κείμενο * /Τα σχόλια είναι μια Πνευματική Τέχνη
Οι περισσότεροι προγραμματιστές γνωρίζουν την αξία των χρήσιμων σχολίων . Ο σχολιασμένος κώδικας διευκολύνει την μεταφορά του κώδικα από ένα μέλος της ομάδας στο άλλο. Τα σχόλια σας βοηθούν στην ομάδα QA να δοκιμάσει τον κώδικα, επειδή μπορεί να πει τι ο προγραμματιστής θέλησε - ακόμα κι αν δεν είχε επιτευχθεί. Δυστυχώς, με τη δημοτικότητα των πλατφορμών δημιουργίας ιστότοπων όπως το Wordpress, που σας επιτρέπουν να ξεκινήσετε και να τρέχετε με ένα επιλεγμένο θέμα που χειρίζεται πολύ, αν όχι όλα, το HTML για εσάς, τα σχόλια δεν χρησιμοποιούνται τόσο συχνά από τις ομάδες ιστού. Αυτό οφείλεται στο γεγονός ότι τα σχόλια είναι πραγματικά δύσκολο να δουν σε περισσότερα οπτικά εργαλεία δημιουργίας, αν δεν εργάζεστε άμεσα με τον κώδικα. Για παράδειγμα, αντί να βλέπετε, στην κορυφή μιας ιστοσελίδας:
Το οπτικό εργαλείο εμφανίζει ένα μικροσκοπικό εικονίδιο για να υποδείξει ότι υπάρχει ένα σχόλιο. Αν ο σχεδιαστής δεν ανοίξει φυσικά το σχόλιο, μπορεί να μην το δει ποτέ. Και στην περίπτωση της παραπάνω σελίδας, θα μπορούσε να προκαλέσει προβλήματα αν επεξεργαστεί τη σελίδα και η επεξεργασία αυτή είναι υπερ-γράφημα από το σενάριο που αναφέρεται στο σχόλιο.
Τί μπορεί να γίνει?
- Γράψτε χρήσιμα και χρήσιμα σχόλια. Μην περιμένετε από άλλους ανθρώπους να διαβάσουν τα σχόλιά σας εάν είναι υπερβολικά μακρά ή δεν περιλαμβάνουν χρήσιμες πληροφορίες.
- Ως προγραμματιστής, πρέπει πάντα να εξετάζετε τα σχόλια που βλέπετε σε μια σελίδα.
- Χρησιμοποιήστε εργαλεία που παρέχονται από τα προγράμματα δημιουργίας που σας επιτρέπουν να προσθέσετε σχόλια.
- Χρησιμοποιήστε τη διαχείριση περιεχομένου για να ελέγξετε τον τρόπο επεξεργασίας των σελίδων.
Ακόμα κι αν είστε το μόνο πρόσωπο που επεξεργάζεται τις ιστοσελίδες σας, τα σχόλια μπορεί να είναι χρήσιμα. Εάν επεξεργάζεστε μια περίπλοκη σελίδα μόνο μία φορά το χρόνο, είναι εύκολο να ξεχάσετε πώς δημιουργήσατε το τραπέζι ή να συνθέσετε το CSS. Με σχόλια, δεν χρειάζεται να θυμάστε, όπως είναι γραμμένο εκεί για εσάς.
Αρχικό άρθρο από την Jennifer Krynin. Επεξεργασμένο από τον Jeremy Girard στις 5/5/17