2 Stimmen

Ein idealer Satz von Unterlagen für ein größeres Projekt

Wenn Sie den Auftrag bekämen, an einem 2 Jahre alten Projekt mit 200.000 Codezeilen zu arbeiten, würde es Ihnen genügen, ein lästiges UML-Diagramm mit 10 Paketen und 3 Komponenten und 2 Seiten Dokumentation zu erhalten?

Was denken Sie, ist eine ideale Menge an Dokumentation, um einigermaßen schnell zu starten, oder gibt es irgendwelche Ratschläge für mich, um mich mit Verständnis von virtualy undokumentierten Projekt mit Klassen, die manchmal 5k Zeilen umfassen zu helfen.

Ich danke Ihnen für Ihre Antworten.

1voto

The Archetypal Paul Punkte 40239

Sie haben mein Mitgefühl :) Ich denke, das allgemeinere Thema "wie man eine neue Anwendung versteht" wäre eine gute Frage für das Community-Wiki

Beginnen Sie mit der Lektüre der Quelle. 200.000 Zeilen sind nicht gerade viel.

Lesen Sie sich die Quelle kurz durch. Dabei geht es nicht darum, alles zu lernen, sondern sich einen Überblick über die Struktur zu verschaffen, über die Stellen, an denen wichtige Dinge erwähnt werden, über die Namensgebung und so weiter. Das Ziel ist es, eine Vorstellung davon zu bekommen, wo die Dinge stehen, so dass Sie zurückgehen und eine detailliertere Lektüre vornehmen können, wenn sich dies als notwendig erweist.

Ich wurde einmal beim Lesen von Code in einer ähnlichen Situation gefragt, was ich da mache. Es war eine interessante Frage, und ich musste über die Antwort nachdenken. In meinem Fall geht es mir darum, eine Vorstellung von den wichtigsten Abläufen der Anwendung und den wichtigsten Datenstrukturen und deren Verwaltung und Änderung zu bekommen.

Wissen Sie, was die Anwendung tut oder tun soll? Funktioniert sie? Wurde sie bereits veröffentlicht? Oder ist sie noch in der Entwicklung? Lässt sie sich überhaupt bauen?

Gibt es Testsuiten? Wenn ja, prüfen Sie diese, um sich ein Bild von der Funktionalität zu machen. Wenn nicht, beginnen Sie mit der Erstellung von Testsuiten, da Sie diese benötigen, um sicher zu sein, dass alle Änderungen, die Sie vornehmen, korrekt sind.

Was müssen Sie mit der Bewerbung tun? Funktionen hinzufügen oder Fehler beheben? Reproduzieren Sie in jedem Fall den "Fehler" (wenn es sich um eine Funktion handelt, schreiben Sie einen Testfall, der aufgrund der fehlenden Funktion fehlschlägt. Wenn es sich um einen Fehler handelt, schreiben Sie einen Testfall, der aufgrund des Fehlers fehlschlägt).

Verfolgen Sie dann die Ausführung, um zu sehen, wo sich der entsprechende Code befindet.

Wiederholen Sie den Vorgang, bis Sie ihn kennen.

1voto

petert Punkte 6602

Ich schließe mich den anderen Kommentaren hier an, aber ich würde auch damit beginnen, die Quelle direkt zu dokumentieren doxygen - Es wird Ihnen helfen, die Dateistruktur der Quelldateien zu "sehen", und dann können Sie anfangen, Kommentare für anwendungsweiten Quell- und Bibliothekscode hinzuzufügen.

0voto

Stunner Punkte 11509

Nun, ich würde sagen, es hängt davon ab, wie gut der Code kommentiert ist. Wenn der Code nicht selbstdokumentierend ist, dann wäre eine zusätzliche Dokumentation auf jeden Fall notwendig. Andererseits, wenn der Code gründlich kommentiert wurde und Funktionsnamen und Variablen selbsterklärend sind, würde ich mir ehrlich gesagt wahrscheinlich nicht einmal die Mühe machen, eine zusätzliche Dokumentation anzusehen, wenn sie zur Verfügung gestellt würde, aber das ist nur meine Meinung.

CodeJaeger.com

CodeJaeger ist eine Gemeinschaft für Programmierer, die täglich Hilfe erhalten..
Wir haben viele Inhalte, und Sie können auch Ihre eigenen Fragen stellen oder die Fragen anderer Leute lösen.

Powered by:

X