Τεκμηρίωση λογισμικού. Η τεκμηρίωση μιας κλάσης είναι πολύ σημαντική γιατί αποτελεί την εικόνα της προς τον έξω κόσμο. Όποιος θέλει να χρησιμοποιήσει.

Slides:



Advertisements
Παρόμοιες παρουσιάσεις
Delicious Dropbox Google docs
Advertisements

Κωνσταντίνος Δελησταύρου Ευγενία Παπαδοπούλου
Δρ. Μαρία Ι. Ανδρέου Εισαγωγή στον Αντικειμενόστρεφη Προγραμματισμό (Object-Oriented Programming) Java Syntax and Style.
Ο Επαγγελματίας Αγρότης Πτυχιακή Εργασία των σπουδαστών: Δεσπότη Παναγιώτη Κυριαζόπουλου Παναγιώτη.
Διαχείριση Έργων Πληροφορικής Απόκτηση, Υλοποίηση και Χρήση Συστημάτων ΤΠΕ, Επιλογή αναδόχου και διαχείριση αλλαγών.
Βάσεις Δεδομένων και Παγκόσμιος Ιστός Προγραμματιστική εργασία: «WebNews»
1 Πανεπιστήμιο Θεσσαλίας – Σχολή Ανθρωπιστικών & Κοινωνικών Επιστημών – ΙΑΚΑ Τομέας Ιστορίας Εργαστήριο Ιστορίας Εκπόνηση εργασιών στην ιστορία
Εισαγωγή στη Νοσηλευτική Επιστήμη Ενότητα 4: Εκτίμηση της κατάστασης του Ασθενή. Κοτρώτσιου Ευαγγελία, Καθηγητής, Τμήμα Νοσηλευτικής, T.E.I. Θεσσαλίας.
ΙΣΤΟΡΙΑ ΘΕΑΤΡΟΥ. Αρχαίο ελληνικό θέατρο Θεός Διόνυσος Διθύραμβος Αρχαίο δράμα Αριστοτέλης Αρίωνας Θέσπης.
ΠΑΝΕΠΙΣΤΗΜΙΟ ΑΙΓΑΙΟΥ ΤΜΗΜΑ ΠΕΡΙΒΑΛΛΟΝΤΟΣ ΠΜΣ Περιβαλλοντική & Οικολογική Μηχανική Μέθοδοι Έρευνας Πέμπτη 10 Μαίου 2012 Ηρακλής Πολατίδης, Δίας Χαραλαμπόπουλος.
Χρήστος Τζεκίνης (σελ:21-28)
ΦΥΛΟ ΚΑΙ ΔΗΜΟΣΙΑ ΔΙΟΙΚΗΣΗ
Εκπαιδευτικό Σενάριο Μάθημα: Κτιριακά Έργα Τάξη: Β’ ΕΠΑΛ Εισηγητές: Μερτίκα Ευθυμία Ράζου Δέσποινα ΜΟΡΦΕΣ ΚΑΙ ΕΙΔΗ ΚΤΙΡΙΩΝ.
ΕΡΕΥΝΗΤΙΚΕΣ ΕΡΓΑΣΙΕΣ Βασική βιβλιογραφία:
Τεχνολογία Επικοινωνιών
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Ενότητα 11 : Η χρήση της MySQL στο Ηλεκτρονικό εμπόριο (ΙΙ)
mke.uop.gr [open source doc / internet]
Εφαρμογές – Γεωργική Πολιτική και Εμπορία Αγροτικών Προϊόντων
ΤΕΧΝΙΚΕΣ Αντικειμενοστραφουσ προγραμματισμου
Εργασία, ψυχαγωγία, κατάρτιση
Προσθήκη διαδραστικότητας στους κόσμους SCRIPTING
ΜΕΤΑΣΧΗΜΑΤΙΣΤΕΣ.
ΤΟ ΑΠΛΟ ΗΛΕΚΤΡΙΚΟ ΚΥΚΛΩΜΑ
Βδομάδα 10_14/3/16 Στόχοι Revision.
Ενότητα 9 : Χρήση Πινάκων στο Ηλεκτρονικό εμπόριο (ΙΙΙ)
ΠΕΡΙΒΑΛΛΟΝΤΑ ΑΝΑΠΤΥΞΗΣ ΕΦΑΡΜΟΓΩΝ
HTML.
Εργασίες μαθητών σχ. έτους 2015 – Ο ΕΚ Ανατολικής Αττικής
Ενότητα 6 : Συναρτήσεις της γλώσσας PHP Ιωάννης Τσούλος
Revision (family, occupation, shopping, making suggestions)
Revision (directions, home, past events, doctor, σε εστιατόριο)
Ενότητα 8 : Χρήση Πινάκων στο Ηλεκτρονικό εμπόριο (ΙΙ) Ιωάννης Τσούλος
Προσεγγίζοντας την έννοια της αειφόρου τοπικής ανάπτυξης μέσα από τον σχεδιασμό ενός ψηφιακού παιχνιδιού 1ο ΕΠΑ.Λ. Αμαρουσίου Σχ. Έτος 2015-’16 Ευτυχία.
Κάτω από webapps του Tomcat
ΚΕΦΑΛΑΙΟ 2 ΒΑΣΙΚΑ ΣΤΟΙΧΕΙΑ ΤΗΣ JAVA
ΠΟΛΛΑΠΛΑΣΙΑΣΤΕΣ KIT N°1 (= 10 τμχ)
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Επιβλέπων Δρ. Τσίτσος Στυλιανός
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Ορισμός της έννοιας αλγόριθμος, πρόγραμμα Σχεδιασμός απλών αλγορίθμων
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Project 5 ΑΝΑΝΕΩΣΙΜΕΣ ΠΗΓΕΣ ΕΝΕΡΓΕΙΑΣ (ΠΕΡΙΒΑΛΛΟΝ ΚΑΙ ΟΙΚΟΝΟΜΙΑ)
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Ανάπτυξη ηλεκτρονικών μαθημάτων στην πλατφόρμα Open eClass
Χρήσιμες Λειτουργίες στο Google Chrome
Ειδικά Θέματα στον Προγραμματισμό Υπολογιστών
Αντικειμενοστραφής προγραμματισμός με GreenFoot
ΜΑΘΗΜΑΤΙΚΕΣ ΕΝΝΟΙΕΣ ΚΑΙ ΦΥΣΙΚΕΣ ΕΠΙΣΤΗΜΕΣ
Nέο Πρόγραμμα Αθήνα, Ιούνιος 2014.
Γ1.6 Τόσο διαφορετικοί και τόσο ίδιοι…
Παπαντώνη Εύα1, Τσεχελίδου Σοφία 2Ζαχαροπούλου Θεολογία3
ΜΑΘΗΜΑΤΙΚΕΣ ΕΝΝΟΙΕΣ ΚΑΙ ΦΥΣΙΚΕΣ ΕΠΙΣΤΗΜΕΣ
Πολιτική Έρευνα Πανελλήνια Κοινωνική Έρευνα.
河川復育【river rehabitation】
Πολιτική Έρευνα Πανελλήνια Κοινωνική Έρευνα.
Η βιβλιοθήκη εκπαιδευτικών δραστηριοτήτων (αποθετήριο) «Ιφιγένεια»
ΟΙΚΟΝΟΜΙΚΗ ΑΝΑΠΤΥΞΗ.
Επιμέλεια παρουσίασης: Γεωργίου Βασίλειος ΣΤ΄ Εξάμηνο Ιούνιος 2018
Πρόληψη και Προαγωγή της Υγείας
Μεταγράφημα παρουσίασης:

Τεκμηρίωση λογισμικού

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

Πώς βλέπουμε την τεκμηρίωση μίας κλάσης; Ανοίξτε το σενάριο FrogEatFlies. Για να δούμε π.χ. την τεκμηρίωση της κλάσης Actor κάνουμε δεξί κλικ πάνω στην κλάση αυτή και επιλέγουμε Open Documentation Το αποτέλεσμα θα είναι να ανοίξει ο φυλλομετρητής (browser) και να μας δείξει την τεκμηρίωση της κλάσης Actor.

Πώς βλέπουμε την τεκμηρίωση όλων των κλάσεων του Greenfoot; Για να δούμε την τεκμηρίωση όλων των κλάσεων του Greenfoot πηγαίνουμε στο μενού Βοήθεια και επιλέγουμε Τεκμηρίωση των κλάσεων του Greenfoot. Στην ιστοσελίδα που ανοίγει εμφανίζονται οι κλάσεις του πακέτου greenfoot με μια μικρή περίληψη του τι κάνει η κάθε μια από αυτές.

Πώς βάζουμε σχόλια στον κώδικά μας; Τα σχόλια χρησιμοποιούνται για να: Τεκμηριώνουμε: τον σκοπό και τους στόχους του προγράμματος μας, τον συγγραφέα του προγράμματος, τις εκδόσεις του κώδικά μας (revision history) κτλ. Περιγράφουμε: πεδία, μεθόδους, κλάσεις και κατασκευαστές. Τα σχόλια που γράφουμε στον πηγαίο κώδικα δεν εμφανίζονται στην εκτέλεση του προγράμματος μας. Ένα σχόλιο πολλών γραμμών γράφεται ανάμεσα στα σύμβολα /* και */. Ένα σχόλιο μιας γραμμής γράφεται μετά από το σύμβολο //.

Πώς δημιουργείται τεκμηρίωση για τις δικές μας κλάσεις; Η δημιουργία τεκμηρίωσης για τις δικές μας κλάσεις στην Java είναι πολύ απλή και γίνεται εντελώς αυτοματοποιημένα, με χρήση του εργαλείου javadoc της γλώσσας. Το javadoc είναι ένα πρόγραμμα για αυτόματη κατασκευή τεκμηρίωσης σε μορφή HTM. Είναι αρκετά χρήσιμο στην κατασκευή βοηθημάτων και τεχνικών αναφορών για εφαρμογές οποιουδήποτε μεγέθους. Παρέχεται ως τμήμα του καθιερωμένου Πακέτου Ανάπτυξης (Development Kit), διατρέχει τον κώδικα ενός πακέτου και δημιουργεί τεκμηρίωση για κάθε μια από τις κλάσεις που αυτό περιέχει.