Mitteln des Bundesministeriums für Bildung und Forschung
unter dem Förderkennzeichen 16OH22005 gefördert.
Die Verantwortung für den Inhalt dieser Veröffentlichung liegt
beim Autor/bei der Autorin.
Clean Code Development Dokumentation
8485 - Software Engineering II
Um was geht es hier?
Was muss ich dokumentieren?
Warum ist Dokumentation wichtig?
Was ist die Zielgruppe der Dokumentation?
Dokumentation Call Level API
Dokumentation WEB-API
17. Oktober 2019 8485 - Software Engineering II - 2 -
17. Oktober 2019 8485 - Software Engineering II - 3 -
Was muss ich
dokumentieren?
Was muss ich dokumentieren?
17. Oktober 2019 8485 - Software Engineering II - 4 -
Dokumentation im Code (I)
17. Oktober 2019 8485 - Software Engineering II - 5 -
Dokumentation im Code (II)
17. Oktober 2019 8485 - Software Engineering II - 6 -
Dokumentation – Call Level API (I)
17. Oktober 2019 8485 - Software Engineering II - 7 -
Dokumentation – Call Level API (II)
17. Oktober 2019 8485 - Software Engineering II - 8 -
Source Code
Kommentare
Dokumentation – Call Level API (III)
17. Oktober 2019 8485 - Software Engineering II - 9 -
Doku mit JavaDoc erstellt
Was ist mit WEB API ?
17. Oktober 2019 8485 - Software Engineering II - 10 -
Dokumentation – WEB API
17. Oktober 2019 8485 - Software Engineering II - 11 -
Wir bilden Zukunft. Dokumentation – WEB API- - Beispiel
17. Oktober 2019 8485 - Software Engineering II - 12 -
Doku mit Swagger
17. Oktober 2019 8485 - Software Engineering II - 13 -
Was muss ich
wissen?
Was muss ich wissen?
Ich kenne die Bedeutung und Einsatzschwerpunkte von
Dokumentation insb.
– Im Quelle-Code – Call-Level API – Web APIs
17. Oktober 2019
8485 - Software Engineering II 8485 - Software Engineering II
- 14 -
