Κατά τον προγραμματισμό σε υπολογιστή, μερικές φορές είναι απαραίτητο να αφήσετε σημειώσεις ή σχόλια, έτσι ώστε άλλοι προγραμματιστές να μπορούν να περιηγηθούν στον κώδικά σας με ευκολία. Είτε πρόκειται για ένα έργο ανοιχτού κώδικα είτε για ένα ιδιόκτητο έργο, χρειάζονται σχόλια για να συντονιστούν με τους συν-προγραμματιστές και τους πιθανούς μελλοντικούς προγραμματιστές επίσης. Χωρίς σχόλια, ο κώδικας θα ήταν απλώς μη διατηρήσιμος.
Βήματα
Βήμα 1. Κατανοήστε τον σκοπό σχολιασμού ενός προγράμματος υπολογιστή
- Η αναγνωσιμότητα είναι το βασικό πράγμα εδώ. Όταν κοιτάτε ένα σχόλιο θα πρέπει να γνωρίζετε ότι είναι ένα σχόλιο και όχι μια γραμμή κώδικα.
- Το σχόλιο θα πρέπει επίσης να είναι χρήσιμο όχι μόνο για εσάς, αλλά για οποιονδήποτε άλλο μπορεί να διαβάσει τον πηγαίο κώδικα του προγράμματος υπολογιστή σας.
Βήμα 2. Σκεφτείτε έναν σύντομο, απλό τρόπο για να ξεπεράσετε το σημείο σας
Τα σχόλια δεν χρειάζεται να είναι έργο τέχνης. Θα πρέπει να είναι συνοπτικοί, τακτοποιημένοι και κατευθείαν στο σημείο.
Ωστόσο, αυτό δεν πρέπει να αποθαρρύνει τη χρήση πολλαπλών γραμμών για ένα σχόλιο. Το θέμα είναι ότι οι πληροφορίες πρέπει να περάσουν στον αναγνώστη
Βήμα 3. Γράψτε το σχόλιο χρησιμοποιώντας την κατάλληλη σύνταξη που δίνει η γλώσσα προγραμματισμού
Βήμα 4. Ρωτήστε τον εαυτό σας εάν το σχόλιο που γράψατε είναι αρκετά λεπτομερές
Ένα σχόλιο θα πρέπει να μπορεί να πει σε κάποιον που κοιτάζει τον πηγαίο κώδικα τι κάνει αυτό το μέρος του προγράμματος χωρίς να χρειάζεται να το μεταγλωττίσει και να το εκτελέσει. Το σχόλιο σας το επιτυγχάνει αυτό; Μεταφέρει όλες τις λεπτομέρειες;
