Ποιες είναι οι σημειώσεις της εξήγησης ότι το πρόγραμμα εγγράφων ή των τμημάτων;

Οι σημειώσεις ότι οι γραμμές εγγράφων ή τα τμήματα ενός προγράμματος ονομάζονται σχόλια .

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

* Σχόλια μονής γραμμής: Αυτά σχολιάζουν μία μόνο γραμμή κώδικα. Παραδείγματα περιλαμβάνουν:

* `// Πρόκειται για ένα σχόλιο μιας γραμμής σε C ++, Java, JavaScript και πολλά άλλα.

* `# Πρόκειται για ένα σχόλιο μονής γραμμής σε Python, Ruby και Bash.»

* Σχόλια πολλαπλών γραμμών (σχόλια μπλοκ): Αυτά τα σχόλια πολλαπλών γραμμών κώδικα. Παραδείγματα περιλαμβάνουν:

* `/* Πρόκειται για ένα σχόλιο πολλαπλών γραμμών στο C, C ++, Java και άλλα.

Μπορεί να εκτείνεται σε πολλές γραμμές. */`

* `'' 'Αυτό είναι ένα σχόλιο πολλαπλών γραμμών στο Python.

Μπορεί επίσης να εκτείνεται σε πολλές γραμμές. '' `

* `" "Αυτό είναι ένα άλλο στυλ πολλαπλών γραμμών σχολιασμού στην Python." "" `

Ο σκοπός των σχολίων είναι:

* Εξηγήστε τον σκοπό του κώδικα: Περιγράψτε τι κάνει η λειτουργία, η κλάση ή το μπλοκ κώδικα.

* Διευκρίνιση της σύνθετης λογικής: Καταρρίψτε τους πολύπλοκους αλγόριθμους ή τα βήματα σε μικρότερα, κατανοητά μέρη.

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

* Παρέχετε πλαίσιο: Εξηγήστε τη συλλογιστική πίσω από ορισμένες επιλογές σχεδιασμού.

* Αφήστε σημειώσεις για μελλοντικές τροποποιήσεις: Διευκολύνετε τους άλλους (ή τον εαυτό σας στο μέλλον) να κατανοήσουν και να διατηρήσουν τον κώδικα.

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