7.6.7 Τεκμηρίωση

Η τεκμηρίωση αφορά το σύνολο των εγγράφων που προκύπτουν καθ’ όλη τη διάρκεια της ανάπτυξης του προγράμματος και βοηθούν το έργο της συντήρησής του αλλά και τη χρήση του. Αυτό το είδος της τεκμηρίωσης λέγεται εξωτερική. Συνήθως, καθένα από τα στάδια που αναφέραμε παράγει και ένα έγγραφο που αναφέρεται στα θέματα του κάθε σταδίου. Π.χ. στο στάδιο του σχεδιασμού το αντίστοιχο έγγραφο θα πρέπει να περιέχει την περιγραφή του αλγόριθμου που επιλέχθηκε για τη λύση του προβλήματος. Η εσωτερική τεκμηρίωση αφορά οποιαδήποτε μορφή τεκμηρίωσης βρίσκεται καταχωρισμένη στον πηγαίο κώδικα του προγράμματος. Συνήθως αποτελείται από σχόλια σε κατάλληλα σημεία του προγράμματος -π.χ. πριν από κάθε υποπρόγραμμα αδρή περιγραφή της λειτουργίας του- και από σωστή και πειθαρχημένη επιλογή των ονομάτων των διαφόρων οντοτήτων του προγράμματος -μεταβλητές, υπορουτίνες, κλπ. Είναι χρησιμότερο από άποψη τεκμηρίωσης το υποπρόγραμμα υπολογισμού εμβαδού τριγώνου να ονομάζεται "emvado_trigonou" παρά "f" ή "et". Παρ’ όλο που σε ορισμένες περιπτώσεις δεν δίνεται η βαρύτητα που πρέπει στη σωστή τεκμηρίωση, θα πρέπει αυτή να θεωρείται εξίσου σημαντική με το ίδιο το πρόγραμμα.

Τρόποι παράστασης αλγόριθμων

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

Βασικά στοιχεία λογικών διαγραμμάτων

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