Κωδικός πηγής Σχόλια Συμβουλές και καλύτερες πρακτικές

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

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

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

Στυλ σχολίου: Επισκόπηση

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

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

Inline Σχολιασμός

Πρακτικά κάθε γλώσσα προγραμματισμού προσφέρει inline σχόλια. Αυτά περιορίζονται στο περιεχόμενο μιας γραμμής και σχολιάζουν μόνο το κείμενο μετά από ένα συγκεκριμένο σημείο. Έτσι για παράδειγμα στο C / C ++ ξεκινάτε ένα σχόλιο inline όπως αυτό:

// ξεκινήστε τη μεταβλητή καταχώρησης var myvar = 1; ... 

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

if (callAjax ($ params)) // εκτελέστε με επιτυχία callAjax με τις παραμέτρους του χρήστη ... code

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

Περιγραφικά μπλοκ

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

/ ** * @desc ανοίγει ένα παράθυρο για την εμφάνιση ενός μηνύματος * @param string $ msg - το μήνυμα που θα εμφανιστεί * @return bool - επιτυχία ή αποτυχία * / λειτουργία modalPopup ($ msg) ... 

Το παραπάνω είναι ένα απλό παράδειγμα ενός σχόλιου περιγραφικής λειτουργίας. Έχω γράψει μια λειτουργία κατά πάσα πιθανότητα σε JavaScript που ονομάζεται modalPopup η οποία λαμβάνει μία μόνο παράμετρο. Στα παραπάνω σχόλια έχω χρησιμοποιήσει μια σύνταξη παρόμοια με την phpDocumentor όπου κάθε γραμμή έχει προηγηθεί με a @ σύμβολο που ακολουθείται από ένα επιλεγμένο πλήκτρο. Αυτά δεν πρόκειται να επηρεάσουν τον κώδικα σας με κανέναν τρόπο, έτσι μπορείτε να γράψετε @περιγραφή αντί @desc χωρίς αλλαγές.

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

Σχόλια ομάδας / κλάσης

Εκτός από το σχολιασμό των λειτουργιών και των βρόχων, οι περιοχές μπλοκ δεν χρησιμοποιούνται τόσο συχνά. Όπου χρειάζεται πραγματικά ισχυρή μπλοκ σχόλια βρίσκονται στην κορυφή των εγγράφων υποστήριξης ή των αρχείων της βιβλιοθήκης σας. Είναι εύκολο να πάτε all-out και να γράφετε στερεά τεκμηρίωση για κάθε αρχείο στην ιστοσελίδα σας - μπορούμε να δούμε αυτή την πρακτική σε πολλά CMS όπως το WordPress.

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

/ ** * @desc αυτή η κλάση θα κρατήσει λειτουργίες για την αλληλεπίδραση των χρηστών * παραδείγματα περιλαμβάνουν user_pass (), user_username (), user_age (), user_regdate () * @author Jake Rocheleau [email protected] * @required settings.php * / αφηρημένη κλάση myWebClass  

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

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

Front-end Κωδικός Σχολιασμός

Τώρα που καλύψαμε 3 σημαντικά πρότυπα σχολίων, ας δούμε μερικά άλλα παραδείγματα. Υπάρχουν πολλοί προγραμματιστές frontend που έχουν μετακινηθεί από τη στατική HTML σε κώδικα jQuery και CSS. Τα σχόλια HTML δεν είναι τόσο σκόπιμα σε σύγκριση με τις εφαρμογές προγραμματισμού, αλλά όταν γράφετε βιβλιοθήκες στυλ και σενάρια σελίδων τα πράγματα μπορούν να γίνουν ακατάστατα με την πάροδο του χρόνου.

Το JavaScript ακολουθεί μια πιο παραδοσιακή μέθοδο σχολιασμού παρόμοια με την Java, PHP και C / C++. Το CSS χρησιμοποιεί μόνο τα σχόλια τύπου μπλοκ που οριοθετούνται από μια κάθετο και τον αστερίσκο. Θα πρέπει να θυμάστε ότι τα σχόλια θα εμφανίζονται ανοιχτά στους επισκέπτες σας, καθώς ούτε το CSS ούτε το JS αναλύονται από την πλευρά του διακομιστή, αλλά οποιαδήποτε από αυτές τις μεθόδους λειτουργεί καλά για να αφήσει ενημερωτικά tidbits στον κώδικα σας για να επιστρέψετε.

Συγκεκριμένα, η κατάργηση των αρχείων CSS μπορεί να αποτελέσει πρόβλημα. Όλοι γνωρίζουμε ότι αφήνουμε ένα σχόλιο για να εξηγήσουμε μια λύση για τον Internet Explorer ή το Safari. Αλλά πιστεύω ότι το σχολιασμό CSS μπορεί να χρησιμοποιηθεί στο jQuery επίπεδο και η PHP να τα χρησιμοποιήσει. Ας δούμε να δημιουργούμε ομάδες στυλ πριν αγγίξουμε κάποιες λεπτομερείς συμβουλές για την κωδικοποίηση σχολίων.

CSS Style Groups

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

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

• @resetsets - απομακρύνει τα προεπιλεγμένα περιθώρια του προγράμματος περιήγησης, την επένδυση, τις γραμματοσειρές, τα χρώματα κλπ.
• @fonts - παραγράφους, επικεφαλίδες, blockquotes, σύνδεσμοι, κώδικας
• @navigation - οι βασικοί σύνδεσμοι πλοήγησης στον κεντρικό ιστότοπο
• @layout - περιτύλιγμα, κοντέινερ, sidebars
• @header & @footer - αυτά μπορεί να διαφέρουν ανάλογα με το σχεδιασμό σας. Τα πιθανά στυλ περιλαμβάνουν συνδέσμους και μη ταξινομημένες λίστες, στήλες υποσέλιδου, επικεφαλίδες, υποσυνείδητα

Κατά την ομαδοποίηση φύλλων στυλ έχω βρει το σύστημα ετικετών μπορεί να βοηθήσει πολύ. Ωστόσο, σε αντίθεση με την PHP ή τη JavaScript, χρησιμοποιώ ένα μόνο @ομάδα ετικέτα που ακολουθείται από μια κατηγορία ή λέξεις-κλειδιά. Έχω συμπεριλάβει 2 παραδείγματα παρακάτω, ώστε να μπορείτε να πάρετε μια αίσθηση για αυτό που εννοώ.

/ ** @group footer * / #footer στυλ ...

/ ** @ footer ομάδας, μικρές γραμματοσειρές, στήλες, εξωτερικοί σύνδεσμοι ** / 

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

4 συμβουλές για καλύτερη styling σχόλιο

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

1. Κρατήστε τα πάντα αναγνώσιμα

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

λειτουργία getTheMail () // κώδικα εδώ θα δημιουργήσει τον κωδικό εκτέλεσης e-mail / * εάν η προσαρμοσμένη κλήση λειτουργίας sendMyMail () επιστρέφει true findMyMail () στο /libs/mailer.class.php ελέγξουμε αν ο χρήστης συμπληρώνει όλα τα πεδία και το μήνυμα αποστέλλεται! * / if (sendMyMail ()) επιστροφή true; // keep true και εμφάνιση επιτυχίας στην οθόνη

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

Ως γενικός κανόνας, αφιερώστε λίγο χρόνο για να σταματήσετε και να προβληματιστείτε πριν γράψετε. Ρωτήστε τον εαυτό σας αυτό που προκαλεί τη μεγαλύτερη σύγχυση σχετικά με το πρόγραμμα και πώς μπορείτε να το εξηγήσετε καλύτερα “ανδρείκελο” Γλώσσα? Επίσης, εξετάστε γιατί γράφετε τον κώδικα ακριβώς όπως είστε.

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

2. Μείωση κάποιου χώρου!

Δεν μπορώ να τονίσω πόσο σημαντικό είναι κενό διάστημα μπορεί να είναι. Αυτό συμβαίνει διπλά αλήθεια για προγραμματιστές PHP και Ruby που εργάζονται σε τεράστιους ιστότοπους με εκατοντάδες αρχεία. Θα κοιτάζετε αυτόν τον κώδικα όλη την ημέρα! Δεν θα ήταν υπέροχο αν θα μπορούσατε να περάσετε απλώς στις σημαντικές περιοχές?

$ dir1 = "/ home /"; // set main home directory $ myCurrentDir = getCurDirr (); // ορίστε τον τρέχοντα κατάλογο χρηστών $ userVar = $ get_username (); // όνομα χρήστη του τρέχοντος χρήστη

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

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

$ hide (); // απόκρυψη της υπο-πλοήγησης στο pageload / ** έλεγχος για ένα συμβάν κλικ σε μια άγκυρα στο εσωτερικό .itm div να αποτρέψει τον προεπιλεγμένο σύνδεσμο ενέργεια, ώστε η σελίδα να μην αλλάζει με πρόσβαση κλικ στο γονικό στοιχείο του .itm ακολουθούμενο από την επόμενη λίστα .sub για εναλλαγή μεταξύ ανοιχτού / κλεισίματος ** / $ ('. itm a') live ('κλικ' ) e.preventDefault (), $ (this) .parent (), επόμενο ('.sub') slideToggle ('γρήγορο');))?);

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

3. Σχόλιο κατά την κωδικοποίηση

Μαζί με την κατάλληλη απόσταση αυτό μπορεί να είναι μία από τις καλύτερες συνήθειες για να μπείτε. Κανείς δεν θέλει να επιστρέψει στο πρόγραμμα μετά από την εργασία και να τεκμηριώσει κάθε κομμάτι. Οι περισσότεροι από εμάς δεν θέλουν καν να επιστρέψουν και να τεκμηριώσουν τις περιοχές που προκαλούν σύγχυση! Πραγματικά χρειάζεται πολλή δουλειά.

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

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

4. Αντιμετώπιση σφαλμάτων Buggy

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

Ακόμη και μετά από έναν νυχτερινό ύπνο μπορείτε να εκπλαγείτε με το πόσο δύσκολο μπορεί να είναι να επιστρέψετε στην κωπήλαυση της κωδικοποίησης. Για παράδειγμα, εάν δημιουργείτε μια σελίδα μεταφόρτωσης εικόνων και πρέπει να την αφήσετε ατελή, εσείς θα πρέπει να σχολιάσει για το πού στη διαδικασία σταμάτησε. Οι εικόνες μεταφορτώνονται και αποθηκεύονται στη μνήμη temp; Ή ίσως δεν αναγνωρίζονται ακόμη στη φόρμα φόρτωσης ή ίσως δεν εμφανίζονται σωστά στη σελίδα μετά τη μεταφόρτωση.

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

συμπέρασμα

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

Αν έχετε προτάσεις για πιο σαφή σχολιασμό του κώδικα, ενημερώστε μας στην παρακάτω περιοχή συζήτησης!