Vorgehen beim Kommentieren von Quelltexten

[quotentoter]

hallo community,

ich erhoffe mir ein paar Tips wie ich am besten ein mir unbekanntes Programm analysiere bzw. kommentiere?
Hab bis jetzt nur eine Vorlesung in C. Das Programm was ich mit Kommentare versehen möchte ist ein OpenSource Projekt und in C++.
In dem Paket sind einige C-Header, C++-Quelltexte und (mein Rechner stuft sie als) unbekannte (.dfm, .bat) Dateien ein. Fang ich am besten mit den Headern an

[anda_skoa]

Ich denke es gibt da mal zumindest zwei unterschiedliche Vorgehensweisen:

• Dem Programmfluss folgen
• Den Abhängigkeiten folgen

D.h. du könntest in der main() Funktion starten und dann versuchen dem Code so zu folgen, wie er exekutiert werden würde.
Oder du sucht nach den Einheiten (z.B. Klassen), die am wenigsten Abhängigkeiten haben und arbeitest von dort aufwärts.

Ich denke der erste Ansatz gibt dir am schnellsten eine Vorstellen, wo in etwas gewissen Sachen gemacht werden, der andere ist eher dazu geeignet, die Interna zu verstehen falls man das Programm umbauen oder erweitern muss.

Ciao,
_

[Fabeltier]

Hallo,

zu Punkt eins "dem Programmfluss folgen", kann Dir evtl ein Debugger wie der gdb helfen, das Program "stepwise" durchzugehen. Allerdings geht das nicht immer und bspw. schon parallele Programmierung per Threads oder Forks kann da Grenzen setzen.

Bei Abhaengigkeiten kann Dir eine IDE oder ein UML Builder helfen das Programm zu "visualisieren" bzw. entsprechend darzustellen. Es gibt da auch diverse Werkzeuge, zB. doxygen.

Was auch nicht zu unterschaetzen ist, ist das Programm an sich kennenzulernen und erst einmal zu benutzen, damit man sieht wie es eigentlich funktioniert.

Zu Fileextensions, gibt's diverse Seiten im Netz, bspw diese hier: http://filext.com/file-extension/

Desweiteren denke ich wirst Du sicherlich auch die eine oder andere API Seite benoetigen, je nachdem auf welcher Platform (Unix / Windows / Linux) man sich befindet und welche Libraries, etc verwendet wurden.

[quotentoter]

ich hab mir mal die ide eclipse für mein system (ubuntu 8.10) besorgt und versuch mal den weg über das debugging.
Auch die variante mit dem visualisieren werde ich mal in angriff nehmen,

vielen Dank

[quotentoter]

Also nun komm ich wieder nicht weiter
Ich habe das Programm über das makefile kompiliert (vorher brauchte ich noch die LAPACK/BLAS Bibliotheken), denn entsteht ja das Programm....wenn ich das nun mit eclipse (c/c++) 3.4.2 öffnen will, erkennt eclipse nicht alle Zeichen

[peschmae]

Du musst ja auch nicht das Programm-Executable im Eclipse Editor öffnen. Vielmehr musst du das ausführen (via Run/Debug). Ausserdem darauf achten dass du das programm auch im Debug-Modus kompiliert hast.

MfG Peschmä

[quotentoter]

also irgendwie verstehe ich das noch nicht ganz mit der entwicklungsumgebung....
wie gehe ich vor wenn ich einen quellcode analysieren möchte? ich lade mir den code herunter, erstelle in eclipse ein projekt, dort kommen die quelltexte rein....muss das jetzt von eclipse kompiliert werden oder davor?

[peschmae]

Kompilieren kannst du das im Prinzip wie du willst; aber wenn du mit Eclipse entwickeln willst dann macht es auch Sinn dir die Sache so einzurichten dass du das aus Eclipse kompilieren kannst.

Um das Programm dann zu Debuggen musst du es aber zwingend aus Eclipse starten (via das Menü Run|Debug; das kann je nach dem etwas mühsam sein bis du dir die Konfiguration richtig zusammengestellt hast damit er auch alles findet was er braucht) und nicht versuchen das Kompilat mit Eclipse zu öffnen wie wenn es eine normale Quelltextdatei wäre. Unabhängig davon ob du das jetzt aus Eclipse kompiliert hast oder nicht.

MfG Peschmä

[anda_skoa]

Abgesehen davon ist ein Debugger meiner Meinung nach ohnehin nur für Detailuntersuchungen brauchbar.

Generellen Überblick über den Exekutionspfad erhält man viel schneller beim eigenständigen Durchlesen.
Ein IDE ist natürlich hilfreich wenn man damit von einem Aufruf einer Funktion leicht zur Deklaration und/oder Definition springen kann, aber keineswegs erforderlich.

Ciao,
_