Programming.QuellcodeDokumentation
Suche:
print pdf

Wie kann ich die Tools zu X-Force kompilieren?Programming.Inhalt


Dokumentation des Quellcodes

Eine der wichtigsten noch anstehenden Aufgaben ist eine öffentliche Dokumentation des Quellcodes, damit neue Programmierer sich besser einarbeiten können.

Die einzelnen Pascal-Dateien sind bereits jetzt gut dokumentiert und sollten keine übermäßigen Verständnisprobleme erzeugen, aber das Problem liegt darin das es keine übergeordnete Dokumentation gibt, was in welcher Datei definiert wird. Dadurch muss ein Programmierer raten wo er die Erklärung einer Funktion nachschlagen muss, die in einer anderen Datei definiert wird.

Dies zu beheben ist das Ziel dieser Dokumentation, die unter Mithilfe der Community erstellt werden sollte. Damit dabei aber keine doppelte Arbeit geleistet wird, bitte ich folgende Richtlinien zu befolgen.

1.) Mittels WinCVS den Sourcecode herunterladen, eine Anleitung befindet sich seit ein paar Tagen auf den Seiten Wie komme ich an den Quellcode von X-Force heran?. TortoiseCVS ist momentan nicht zu empfehlen, irgendwas macht dort Probleme trotz korrekter Zugangsdaten (mal klappt es, mal nicht).

2.) Unter den Links unten befinden sich Links zu den einzelnen Pascal-Dateien (wenn ein Name fehlt, einfach ergänzen). Sucht Euch eine bisher unbearbeitete Datei aus und tragt dann im Wiki hinter den Namen der Datei das aktuelle Datum, euren Namen und den Status "in Bearbeitung" ein.

3.) Legt in der untergeordneten Wiki-Seite eine Liste aller Funktionen und Variablen an, die in der gewählten Datei definiert werden. Dies ist normalerweise nur eine Kopie der ersten Deklarationszeilen bis zur Implementation. Kopiert dabei auch die Beschreibung, die Jim der gesamten Datei gegeben hat.

4.) Ergänzt jede Prozedur und Variable mit einem kurzen Kommentar, was diese Funktion laut der Implementierung macht. Wenn ihr etwas nicht ermitteln könnt dann schreibt dort unbekannt - am besten mit einer Liste derjenigen nicht identifizierbaren anderen Funktionen und Variablen, die von dieser Prozedur aufgerufen werden.

5.) Wenn Ihr nicht mehr weiter kommt, dann korrigiert den Statuseintrag im Inhaltsverzeichnis auf "Teilbearbeitet" oder "vollständig zur Gegenkontrolle" und nehmt Euch die nächste Datei vor.

6.) Die erfahreneren Programmierer können sich später dann auch mal die teilbearbeiteten Dokumentationen vornehmen, speziell wenn die vorher unidentifizierbaren Funktionen zwischenzeitlich in den anderen Dateien gefunden und gelistet wurden - dann wieder ab Punkt 2 vorgehen.


Dokumentation zum XForce-Hauptprogramm-Quellcode

Dokumentation zum Spielsatz-Editor-Quellcode

Dokumentation zum Karteneditor-Quellcode

Dokumentation zum Tileseteditor-Quellcode

Andere Dokumentationen z.B. zum Programm zur error.txt-Analyse werden später angegangen, diese Utilities sind erstmal nicht so wichtig.


Letzte Änderungen - Menü bearbeiten
Zuletzt bearbeitet am 24.10.2006, 18:19 von DirkF
Bearbeiten - Attribute - Historie