Τι σημαίνει να σχολιάζεις μια γραμμή σε php. Πώς να σχολιάσετε για λίγο HTML, CSS ή PHP, κώδικα JS. Σύνταξη σχολίου Php: σχόλιο μονής γραμμής

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

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

… Καλός!

Αλλά σημειώστε ότι τα σχόλια χρησιμοποιούνται επίσης σε html και php... Αλλά οι περισσότεροι αρχάριοι μπερδεύονται στο αρχικό στάδιο της εργασίας τους με τον ιστότοπο και δεν ξέρουν πώς να προσθέσουν τις απαραίτητες εξηγήσεις για τον εαυτό τους. Μετά από όλα, συμβαίνει έτσι, για παράδειγμα, πρέπει να απενεργοποιήσετε για κάποιο χρονικό διάστημα κώδικας html, και μετά συνεχίστε ξανά τη λειτουργία του - είναι εύκολο να το εφαρμόσετε εάν έχετε κάνει σημειώσεις για τον εαυτό σας στα «περιθώρια», αλλά ποτέ δεν ξέρετε τι.

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

Σχολιάζοντας τον κώδικα CSS

a: τοποθετήστε το δείκτη του ποντικιού, α: εστίαση (χρώμα: # D5071E; διακόσμηση κειμένου: Υπέργραμμη; / * ΥΠΟΓΡΑΜΜΙΣΗ ΕΠΑΝΩ * /)

Έτσι εξηγείτε στον εαυτό σας. Ή μπορείτε ακόμη και να σχολιάσετε αυτό το σενάριο css εντελώς ως εξής: απλώς αναδιπλώστε

/ * εδώ ΚΩΔΙΚΟΣ * /

/ * a: αιώρηση, α: εστίαση (χρώμα: # D5071E; διακόσμηση κειμένου: υπογράμμιση; / * ΥΠΟΓΡΑΜΜΙΣΗ * /) * /

Εφιστώ την προσοχή σας στο γεγονός ότι - μπορείτε να σχολιάσετε τον πλήρη κύκλο του κώδικα css με αυτόν τον τρόπο, αλλά !! τότε πρέπει να αφαιρέσετε τα επαναλαμβανόμενα σχόλια / * ΥΠΟΓΡΑΜΜΙΣΗ ΚΑΤΩ * / ή να παίξετε με κάθετες, εάν η εξήγηση είναι σημαντική))

Διαφορετικά θα υπάρξει σφάλμα!!

Σημείωση:

Αν ανοίξετε τον πηγαίο κώδικα της σελίδας - Ctrl + U και ρίξετε μια ματιά ... θα δούμε ότι το σχολιασμένο κομμάτι κώδικα css εμφανίζεται όμορφα στο έγγραφο που δημιουργήθηκε! αυτό είναι εάν χρησιμοποιήθηκε το css (οι ιδιότητες είχαν οριστεί) απευθείας σε html

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

Το αγγλικό επίρρημα (λέξεις) θα είναι ευανάγνωστο. Ρωσικός συμβολισμός - όχι.

Σχολιάζοντας τον κώδικα HTML

Το αρχείο XML σχολιάζεται με τον ίδιο τρόπο.

Σημαντικό: ελέγχετε πάντα τον κωδικό που παρέχεται στα άρθρα, τουλάχιστον οπτικά) διαφορετικά μπορεί να υπάρχουν σφάλματα.

Η συνήθης απροσεξία κατά τη μορφοποίηση μπορεί να είναι χρονοβόρα, για παράδειγμα, ο κώδικας ΣΧΟΛΙΑΣΜΕΝΟΣ που εμφανίζεται παραπάνω είναι συχνά λανθασμένος: αντί για δύο σύντομες παύλες, εμφανίζεται μια παύλα em:

Προς ενημέρωσή σας:

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

Να το έχετε υπόψη σας.

Και εδώ είναι κάτι άλλο:

εκτός από το γεγονός ότι ο σχολιασμένος κώδικας εμφανίζεται στον πηγαίο κώδικα της σελίδας (που σημαίνει ότι υποβάλλεται σε επεξεργασία κατά μία έννοια, αν και θα είναι αόρατος και στη σελίδα!) - είναι καλύτερο να αφαιρέσετε ορισμένες συναρτήσεις php σε συνδυασμό με html από το ενεργό έγγραφο.

Για παράδειγμα:

θα είναι ορατό στο έγγραφο και τη λειτουργίαθα κάνει θαυμάσια τη δουλειά του: δηλαδή, οι πληροφορίες δεν θα φαίνονται στο frontend, αλλά στην πηγή - θα εμφανίζονται καθαρά! και αυτό είναι ένα απίστευτο αίτημα προς τη βάση δεδομένων: όλα αυτά είναι ασήμαντα, αλλά πρέπει να ξέρετε!

Μπορείτε να το κάνετε αυτό εάν δεν θέλετε να αφαιρέσετε ένα κομμάτι κώδικα από το έγγραφο:

προσθέστε πριν τον απαραίτητο «έξτρα» κώδικα html το άνοιγμα... ενσωματωμένη λειτουργία ... και κλείσιμο;> ...

Με μια λέξη, μπορείτε να το κάνετε αυτό εάν ο κωδικός είναι μεγάλος:

**/ ?>

τότε η πηγή θα είναι καθαρή!

Ή πιο απλά:

Ας σχολιάσουμε την ίδια τη συνάρτηση στο έγγραφο html. Ο πηγαίος κώδικας σε αυτές τις περιπτώσεις θα είναι καθαρός σε σχέση με την ανάπτυξη λειτουργιών!

πώς να σχολιάσετε το JavaScript

εάν (beingShown || εμφανίζεται) (// μην ενεργοποιήσετε ξανά το animation;) αλλιώς (// στη γραμμή εφαρμόστε ΟΠΟΙΟΔΗΠΟΤΕ ΣΧΟΛΙΟ // στη γραμμή εφαρμόστε ΟΠΟΙΟΔΗΠΟΤΕ ΣΧΟΛΙΟ // true;

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

Όπως καταλαβαίνετε, η κάθετο "//" είναι διπλή, αυτό είναι το ΣΗΜΑ του σχολίου ... ΜΙΑ ΓΡΑΜΜΗ!

Ο υπόλοιπος κώδικας JS σχολιάζεται σαν php, περισσότερα για αυτό παρακάτω:

παρατήρηση:

Σχολιασμός του κώδικα PHP

... και ... εδώ είναι το ίδιο - κάθετο-κάτο ... μονογραμμή.

Αλλά σημειώστε ότι μπορεί να σχολιαστεί ακριβώς όπως ο κώδικας CSS.

... ή έτσι μπορείτε να σχολιάσετε - μια επιλογή μίας γραμμής, όταν χρησιμοποιούμε ΟΧΙ ΔΥΟ ΚΑΘΙΣΤΕΣ, αλλά BECAR (κατακερματισμός) πριν από τη γραμμή που σχολιάστηκε:

... Φυσικά, πρέπει να σχολιάσετε προσεκτικά στον βρόχο κώδικα!

... ή με τον ίδιο τρόπο - παρόμοιο με το παραπάνω παράδειγμα για το CSS ... δηλ. αυτή η επιλογή / * code * / σχολιασμός θα λειτουργήσει και για τους κωδικούς CSS και JS!

Αλλά με αυτόν τον τρόπο, μπορείτε να σχολιάσετε μια πιο ογκώδη εξήγηση στον κώδικα PHP, κάπου ανάμεσα στα κύρια παραδείγματα του ...

Μπορείτε επίσης να σχολιάσετε σε βρόχους php όπως αυτό, εάν ο κώδικας είναι αναμεμειγμένος ... php και κάπως html

Παρόμοια με τα παραπάνω:

Για παράδειγμα, κάποιο είδος συνάρτησης ... κάπου στον γενικό κώδικα (ή ένας βρόχος στο html):- μπορείτε να σχολιάσετε, δηλαδή να προσθέσετε τη δική σας ετικέτα ως εξής:

ή κάπως έτσι: μια επιλογή μιας γραμμής ...

Νοημοσύνη:

Ο κώδικας php δεν είναι ορατός σε κανέναν πηγαίο κώδικα !! μόνο το λειτουργικό του αποτέλεσμα είναι ορατό - λειτουργεί!

Γενικά, αυτό ήθελα να αναφέρω σήμερα!

Τώρα μπορείτε να πειραματιστείτε ... Καλή τύχη.

Και φυσικά, διαβάστε τα άρθρα του ιστότοπου και εγγραφείτε:
Μοιράζομαι την πικρή μου εμπειρία - κάποιες γνώσεις, για τη γλυκιά σας ευημερία))

... η πόλη των webmasters Mikhalika.ru© - Εύκολα με WordPress

Σε αυτό το μάθημα, θα μιλήσω για το πώς σχόλια σε HTML, CSS, PHP... Τα σχόλια είναι κείμενο που δεν είναι ορατό στην ιστοσελίδα. Χρησιμοποιούνται για κάθε είδους επεξηγήσεις, υπενθυμίσεις, περιγραφές για webmasters, κάτι που σας επιτρέπει να δομήσετε το έγγραφο. Τα σχόλια είναι απαραίτητα κατά τον εντοπισμό σφαλμάτων κώδικα, σας επιτρέπουν να περιηγηθείτε γρήγορα στη σήμανση μιας ιστοσελίδας και να βρείτε το μπλοκ που χρειάζεστε. Συχνά, τα σχόλια χρησιμοποιούνται για τον εντοπισμό σφαλμάτων κώδικα HTML. Για παράδειγμα, μπορείτε να σχολιάσετε προσωρινά ένα συγκεκριμένο μπλοκ κώδικα, ώστε να μην εκτελείται και, εάν είναι απαραίτητο, να μπορεί εύκολα να αποκατασταθεί.

Σχόλια HTML

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

Παράδειγμα σχολίων HTML

Σχόλια στο CSS

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

/ * Αρχή ενός μπλοκ με στυλ για Body * / body (φόντο: #efeded; γραμματοσειρά-οικογένεια: Verdana, Helvetica, sans-serif; μέγεθος γραμματοσειράς: 12 px; περιθώριο: 0 px; padding: 0px;) / * Τέλος του ένα μπλοκ με στυλ για Body * /

Σχόλια PHP

Τα σχόλια PHP μπορούν να είναι μονής γραμμής ή πολλαπλών γραμμών:

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

2) Για την υλοποίηση σχολίων πολλαπλών γραμμών, χρησιμοποιούνται τα ακόλουθα σύμβολα: / * και * /. Αυτή η επιλογή είναι χρήσιμη εάν το σχόλιο εκτείνεται σε πολλές γραμμές.

Έτσι, μάθαμε να κάνουμε

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

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

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

Σύνταξη σχολίου Php: σχόλιο μονής γραμμής

Ενώ η html έχει μόνο ένα είδος σχολίων, η PHP έχει δύο. Ο πρώτος τύπος που θα συζητήσουμε είναι το σχόλιο μιας γραμμής. Δηλαδή, ένα σχόλιο που λέει στον διερμηνέα να αγνοήσει όλα όσα συμβαίνουν σε αυτή τη γραμμή στα δεξιά των σχολίων. Για να χρησιμοποιήσετε αυτό το σχόλιο, χρησιμοποιήστε τους χαρακτήρες "//" ή "#" και όλο το κείμενο στα δεξιά θα αγνοηθεί από τον διερμηνέα PHP.

Psst ... Δεν μπορείτε να δείτε τα σχόλιά μου στην PHP! // ηχώ "τίποτα"; // echo "My name is Humperdinkle!"; # echo "Δεν κάνω τίποτα ούτε ";?>

Αποτέλεσμα:

Γειά σου Κόσμε! Psst ... Δεν μπορείτε να δείτε τα σχόλιά μου στην PHP!

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

Σύνταξη σχολίου Php: σχόλιο πολλαπλών γραμμών

Όπως τα σχόλια HTML, τα σχόλια πολλών γραμμών PHP μπορούν να χρησιμοποιηθούν για να σχολιάσουν μεγάλα μπλοκ κώδικα ή για να γράψουν σχόλια σε πολλές γραμμές. Τα σχόλια πολλών γραμμών στην PHP ξεκινούν με "/ *" και τελειώνουν με "* /". Οτιδήποτε ανάμεσα σε αυτούς τους χαρακτήρες θα αγνοηθεί.

Αποτέλεσμα.

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

Σχόλια: καλό και κακό

Ο σχολιασμός κώδικα είναι διαθέσιμος στις περισσότερες γλώσσες προγραμματισμού (πιθανώς σε όλες, αλλά με διαφορετικούς βαθμούς διαθεσιμότητας). Συνήθως, οι λεκτικές διευκρινίσεις χρησιμοποιούνται για να βοηθήσουν άλλα μέλη της ομάδας να αναπτυχθούν περαιτέρω ή απλώς για να υπενθυμίσουμε στον εαυτό μας ότι αυτή η περιοχή χρειάζεται επιδιορθώσεις («FIX ME»).

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

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

JavaScript. Γρήγορη εκκίνηση

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

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

Μερικές φορές ένα παρόμοιο συναίσθημα κυριεύει τους επαγγελματίες. Για παράδειγμα, όταν όλα φαίνονται εκπληκτικά στραβά, πρέπει να υπάρχει καλύτερη λύση. Για να σώσει τους ακόλουθους από την αναζήτηση του καλύτερου, ο προγραμματιστής μπορεί να αφήσει μια σημείωση ως εξής: # time_spent_here = 24h

Μετά από τέτοια λόγια, λίγοι άνθρωποι θέλουν να ξοδέψουν τόσο πολύ χρόνο. Έτσι, προειδοποιείτε ότι πολλές διαφορετικές επιλογές έχουν ήδη διευθετηθεί. Ταυτόχρονα, θα πρέπει να αποφεύγετε τέτοιες επιθέσεις: #i_hate_this, # try_to_do_better_ass %% le. Με αυτόν τον τρόπο, δείχνετε μόνο μια αντιεπαγγελματική στάση. Μην συμβιβάζετε τον εαυτό σας και τον εργοδότη σας.

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

Η ετικέτα ως λειτουργικό στοιχείο

Ενώ ο σχολιασμός προορίζεται να είναι μια εξήγηση και βοήθεια για την ανάπτυξη της ομάδας, αυτά τα χαρακτηριστικά δεν χρησιμοποιούνται συνήθως. Κατά κανόνα, οι ετικέτες τοποθετούνται εκεί που θέλουν να σταματήσουν την εκτέλεση του κώδικα. Ας υποθέσουμε ότι έχετε ενσωματωμένη PHP σε HTML. Και δεν θέλετε να το σβήσετε, απλά θέλετε να δείτε πώς φαίνεται η σελίδα χωρίς αυτό. Για να το κάνετε αυτό, πρέπει να ακολουθήσετε την ακόλουθη σύνταξη:

JavaScript

…

…< div > . . . < / div > < ? -- закомментированныйкоднаphp -- > < div > . . . < / div >

Όπως μπορείτε να δείτε, με απλές ενέργειες, μπορείτε να σταματήσετε την εκτέλεση του κώδικα χωρίς καν να εκτελέσετε σύνθετες λειτουργίες. Αλλά, στην πραγματικότητα, αυτό δεν είναι ακόμη το ύψος της βελτιστοποίησης. Πρόσθετη ευκολία για τον προγραμματιστή παρέχεται από το ίδιο το phpStorm IDE. Χρησιμοποιώντας την επισήμανση και τις συντομεύσεις πληκτρολογίου, μπορείτε να σχολιάσετε το επιλεγμένο τμήμα κώδικα χωρίς να επισυνάψετε εξειδικευμένες ετικέτες. Αυτό μπορεί να γίνει ως εξής.

Χρησιμοποιώντας μια μέθοδο που σας ταιριάζει, επιλέξτε ένα τμήμα κειμένου (ποντίκι, συντομεύσεις).

Πατήστε τη συντόμευση πληκτρολογίου Ctr + Shift + /

Επιπλέον, μπορείτε να σχολιάσετε την τρέχουσα γραμμή. Όλα είναι ίδια, μόνο χωρίς Shift.

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

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

JavaScript. Γρήγορη εκκίνηση

Μάθετε τα βασικά της JavaScript με ένα πρακτικό παράδειγμα κατασκευής μιας διαδικτυακής εφαρμογής