Wie bereits geschriebenen Quellcode in doku schreiben?

[chooter696]

Ich bin noch immer dabei meine doku zu schreiben und überlege gerade wie man es schreiben kann das man bestimmte funktionen und bilder schon vor dem Projekt entwickelt hat und diese in dem Abschlussprojekt wieder einbringen konnte und somit zeit für die entwicklung gespart hat. Weil meine Abschlussarbeit für 70 Stunden zwar mächtig aussieht aber halt schon vieles bereits von mir entwickelt war.

[itazubi]

Wiederverwendbarkeit. Anders hab ich gelesen "bereitgestellte Funktionen". Wenn du auf oo-basierende Funktionen zugreifst, dann macht das dein Programm interessant. In großen Firmen wirst du nicht darum herum kommen, die Funktion für x einzusetzen. Erstens wird dein Projektleiter drauf bestehen und zweitens ist die Funktion schon ausgereift. Du musst eben deine 70 Stunden erreichen. Wenn du aufgrund dieser Aussage jetzt in der Doku 65 Stunden stehen hast, dann würde ich es mir nochmal überlegen ;-)

[Pixie]

1. sieht mein Vorredner

2. Wenn Du betonen willst, dass das auch aus Deiner Feder stammt, kannst Du vielleicht auch im Anhang eine Übersicht zufügen, was von Dir im Rahmen des Gesamtprojektes erstellt wurde und was davon speziell im Rahmen der Projektarbeit. Schick wärs dann, wenn Du eine klare Linie ziehen kannst, Stichwort Abgrenzbarkeit. Also z.B. dass die von Dir während der Ausbildung erstellte Bibliothek Bla um die Funktionalitäten für Blubber erweitert wurden und im Projekt für Sabbel, Sülz und Schmalz eingesetzt werden... vielleicht auch noch mit jeweils einem Codebeispiel dazu....

.

[Sinnfreie-Flut]

Mein Abschlussprojekt habe ich in Java realisiert.

Einen Punkt der Dokumentation habe ich so aufgegliedert das zu jeder verwendeten Klasse ein Klassendiagramm ersichtlich ist mit den dazugehörigen Methoden welche ich verwende. Unter den Klassendiagrammen habe ich dann eine Tabelle mit 3 Spalten für : Methodenname, Funktionalität, Persönliche Tätigkeit erstellt. Bei Persönlichen Tätigkeiten habe ich dann dazugeschrieben ob ich diese Methoden nur anspreche, abändern oder erstellen musste. Denke damit läuft man eine gute Schiene