Banner left   Banner center   Banner right

Germanenglish Home · News · Diary · Screenshots · Documentation (Wiki) · Downloads · Guestbook · Forum

Home · Benutzer registrieren · Suchen · Statistik · FAQ · Benutzerliste

Zur Zeit online: keiner ausser dir

 X-Force - Fight For Destiny - Forum —› Tutorial / Anleitung —› Absprachen zur Dokumentation

Autor Mitteilung
verfasst am: 25.10.2006, 18:18
Admin, Spielsatz GalWar

Registrierdatum: 31.08.2005, 21:51

 Beiträge: 5595
Hier können alle Leute ihre Bemerkungen zur gerade gestarteten Code-Dokumentation durchführen.

Ich werde diese Dokumentation anschließend noch vernünftig außerhalb des Wikis zusammenfassen, deshalb muss keine perfekte Formatierung vorliegen, es muss nur lesbar sein.

Hinweis: zwei Returns erzeugen ebenfalls einen neuen Absatz, den Umbruch muss man nur erzwingen wenn eine neue Zeile direkt unter der vorherigen entstehen soll - unnötig für diese grobe Dokumentation, besser mehr Leerzeilen setzen.

Weshalb ich die Dokumentation so öffentlich mache? Es gibt eine ganze Reihe von Arbeiten die nur ich machen kann, weil man dafür besondere Rechte braucht. Die Code-Dokumentation kann dagegen von jedem teilweise gemacht werden und braucht keine besonderen Rechte, d.h. damit können auch andere Anfangen während ich z.B. die Homepage aufräume (wird aber auch noch ein paar Tage dauern bevor man davon was sieht).
verfasst am: 26.10.2006, 15:06
Registrierdatum: 13.04.2005, 16:36

 Beiträge: 618
also ich hab da folgende ideen:
einmal zusammengefasstebedeutung der bereiche zb was ist api,
Ich schlag hierfür mal vor das einmal generell in die wikipedia zu verlinken wie: http://de.wikipedia.org/wiki/Programmierschnittstelle
und einmal zu beschreiben was der bereich bei xforce genau macht, und wie er ungefähr stuckturiert ist.

einmal ordnung nach programmiertechnischen thematischen bereichen um schnell einen bug zuzuordnen:
Eine thematik wäre zb inventar, auf der seite stehen dann alle links (zu den doku seiten) inn denen man suchen sollte um ein problem mit dem inventar zu lösen.
verfasst am: 29.10.2006, 17:49
Registrierdatum: 13.04.2005, 16:36

 Beiträge: 618
dirk darf ich dich bitten zu den code dokumentationsseiten die bereits da sind (eine von mir eine von arnel) einen kommentar abzugeben ob es das ist was du dir vorstellst, bzw zu sagen was fehlt oder aders sein sollte ^^
verfasst am: 30.10.2006, 11:50
Admin, Spielsatz GalWar

Registrierdatum: 31.08.2005, 21:51

 Beiträge: 5595
Ich hab bisher nur grob durchgeschaut, ein paar Anmerkungen habe ich - bin nur nicht fit genug um die niederzuschreiben.

Mich hatte Mitte letzter Woche eine Infektion erwischt die deutlich schwerer war als ursprünglich gedacht - wenn heute morgen beim Arzt die Werte nicht endlich eine Besserung angezeigt hätten dann wäre ich wohl ins Krankenhaus gewandert.
Ich hoffe das ich mich morgen wieder darum kümmern kann...
verfasst am: 30.10.2006, 18:19
Registrierdatum: 13.04.2005, 16:36

 Beiträge: 618
ohje, das hört sich echt übel an, na dann gute besserung.
verfasst am: 30.10.2006, 18:53 · Edited by: Moderator
Programmierer

Registrierdatum: 23.08.2003, 19:16

 Beiträge: 2261
Zitat: DirkF
Mich hatte Mitte letzter Woche eine Infektion erwischt die deutlich schwerer war als ursprünglich gedacht - wenn heute morgen beim Arzt die Werte nicht endlich eine Besserung angezeigt hätten dann wäre ich wohl ins Krankenhaus gewandert.
Ich hoffe das ich mich morgen wieder darum kümmern kann...
Jo, auf diesen Wege auch von mir alles Gute ;)

(Edit: Zitatursprung korrigiert)
verfasst am: 30.10.2006, 19:25
Admin, Spielsatz GalWar

Registrierdatum: 31.08.2005, 21:51

 Beiträge: 5595
Naja, ist nicht ganz so schlimm wie es sich angehört haben mag - es ist nur so das ich auf der einen Seite Diabetis habe und auf der anderen Seite die Magen-Darm-Infektion dazu geführt hatte, das ich in vier Tagen zusammen genommen nur soviel essen konnte wie sonst zu einer einzigen Mahlzeit alleine.
Wenn durch die Infektion und den Bruch der vorgeschriebenen Diät die Zuckerwerte außer Kontrolle geraten wären, dann hätte ich zur Neueinstellung ins Krankenhaus gemußt.
Glücklicherweise haben sich die Werte mit dem Abklingen der Krankheit auch von alleine wieder normalisiert - ich bin nur ziemlich fertig, denn mit so wenig Nahrung war am Ende selbst Treppensteigen ein Kraftakt - und meine Zimmer liegen im Dachgeschoss.

Jetzt kann ich wieder halbwegs normal essen, auch wenn der Magen noch empfindlich ist - morgen, spätestens übermorgen sollte wieder alles OK sein.

Trotzdem Danke für die Besserungswünsche.
verfasst am: 31.10.2006, 22:51 · Edited by: Sento
Registrierdatum: 13.04.2005, 16:36

 Beiträge: 618
jim das zitat stammte nicht von mir aber trotzdem auch von mir danke für die guten wünsche ;)
Wegen der online doku wärs für mich halt wichtig mit dem überprüfen weil ich danach auch erst weitermachen würde sonst könntes die doppelte arbeit sein ^^
verfasst am: 01.11.2006, 12:31
Admin, Spielsatz GalWar

Registrierdatum: 31.08.2005, 21:51

 Beiträge: 5595
Die Überprüfung der Doku kommt auf jeden Fall noch heute, ich kann nur noch nicht sagen wann genau.
Dann schreibe ich hier auch nochmal was dazu.
verfasst am: 02.11.2006, 01:41 · Edited by: DirkF
Admin, Spielsatz GalWar

Registrierdatum: 31.08.2005, 21:51

 Beiträge: 5595
Wie versprochen hier die Kommentare zur Dokumentation. Leider sind die API-Dateien aufgrund ihrer Funktion etwas klein und gerade nicht das wo es die meisten Probleme geben wird, es wird also weitere Absprachen geben müssen sobald die ersten Components-Dateien dokumentiert werden.

Ich habe eine der beiden bereits bestehenden Dateien umformatiert, die andere kann sich später jemand vornehmen, ist mir bereits zu spät.

Damit zu den Kommentaren:

1.) Bitte groß als Titel erneut den Dateinamen mit dem kompletten Pfad setzen, man sollte später auch bei Ausdrucken etc. die Dokumentation noch zuordnen können (bei beiden vergessen)

2.) Bitte immer eine Einleitung über die Funktionalität dieser Datei - meistens steht dies schon in den Rem-Zeilen von Jim und kann kopiert werden, andernfalls einen entsprechenden Kommentar selber schreiben (wurde in der zweiten Dokumentation nicht mit kopiert).

3.) Bitte keine unnütze Mühe mit manuellem Zeilenumbruch oder super sauberer Formatierung - das sind Arbeitstexte die später sowieso neu formatiert werden müssen.
Am schnellsten, einfachsten und besten geht das wenn ihr die Code-Tags für einen Delphi-Sprachblock verwendet, ich habe das bei der einen Datei vorgemacht und die manuellen Zeilenumbrüche wieder gelöscht - bitte auch die andere so korrigieren.
Kleine Tips: Die gesamte Einleitung des Tags muss in einer Zeile geschehen (kein Zeilenumbruch, aber ein Leerzeichen zwischen dem Wort delphi und der Klammeröffnung) und der Klammerschluss sollte in der letzten Codezeile hinten und nicht in einer eigenen Zeile geschehen (sonst verschiebt sich die Nummerrierung)

WICHTIG WICHTIG
4.) Jim hat nicht immer jede Funktion kommentiert. Deshalb sollte vor der Kopie der Deklarationen kontrolliert werden ob Kommentare fehlen und diese gegebenenfalls ergänzt werden.
Für eine einfache gedankenlose Kopie des Deklarationskopfes müssten wir uns keine solche Arbeit machen, und bei den beiden ersten dokumentierten Dateien wurde in beiden Fällen prompt genau das übersehen - im Fall von der country_api.pas wurde sogar eine komplette Funktionsdeklaration vergessen mitzukopieren.
WICHTIG WICHTIG

5.) Wenn eine Prozedur oder Funktion nicht zugeordnet werden kann bzw. ihre Funktion nicht ermittelt werden kann, dann sollte sie trotzdem eine Kommentarzeile in der Form
// unbekannt
erhalten, damit man später besser danach suchen kann.

Ich habe übrigens den entsprechenden Funktionen in der country_api.pas den Status unbekannt trotz des teilweise offensichtlichen Sinn der Funktionen (laut Namen) gegeben, weil in der API nur Schnittstellen beschrieben sind und diese Funktion besser detailliert beschrieben wird, wenn die richtige aufgerufene Funktion in einer anderen Datei korrekt dokumentiert ist.

Bei weiteren Fragen einfach posten ;-)
verfasst am: 04.11.2006, 02:06
Registrierdatum: 13.04.2005, 16:36

 Beiträge: 618
So ich habeuch jetzt wieder einige seiten zur überprüfung gegeben.
der delphi code setzt hinter jede zeite automatisch noch eine leere zeitle, ist das normal?
verfasst am: 19.11.2006, 09:45
Admin, Spielsatz GalWar

Registrierdatum: 31.08.2005, 21:51

 Beiträge: 5595
Mal ein paar Infos für diejenigen die sich wundern weshalb ich die letzten Dateien der Code-Analyse noch nicht geprüft habe.

Ich hatte ehrlich gesagt gehofft, das sich auch noch weitere Leute aus der Community finden, die ihre Ergebnisse dann auch gegenseitig prüfen und korrigieren.

Dahinter steht eine Frage der Effektivität - das sich momentan nichts sichtbar ändert liegt keineswegs daran das das Team nichts macht, sondern es werden vielfach interne Arbeiten geleistet, die hoffentlich in wenigen Wochen etwas neues für das Spiel bringen.

Es gibt halt Aufgaben die theoretisch jeder aus der Community machen kann, und es gibt anderes was aufgrund der Zugriffsrechte nur von wenigen Leuten gemacht werden kann - wie auch zuletzt die Änderung der Hauptseite im Wiki um die zusätzlichen Erklärungen und den Link auf das Inhaltsverzeichnis.

Die Code-Analyse erfordert Arbeitszeit, das ist ganz klar. Momentan hoffe ich das ich für einen guten Teil dieser Arbeit weitere Leute aus der Community finde - wenn dies nicht der Fall ist, dann werde ich mich in dem Moment darum kümmern, in dem ich die Daten wirklich für Umprogrammierungen am Spiel benötige. Nur bedeutet dies dann natürlich auch, das sich diese Umprogrammierung zeitlich etwas verschiebt - je mehr vorher Hilfe aus der Community gekommen ist, umso schneller wird es vorwärts gehen.

Um die Analyse etwas effektiver zu gestalten hier aber mal ein paar Zusatzinformationen, welche Code-Abschnitte höchstwahrscheinlich als erstes gesucht werden:

1.)
Es wird Änderungen in der Abspeicherung von Tilesets und Kartendateien geben - wie ja teilweise öffentlich (und intern noch weitergehend) diskutiert wurde.
Dafür werden wir irgendwann eine Dokumentation der Dateien benötigen, in denen diese Daten geladen und verarbeitet werden - Grafikengine, Aufruf des Bodeneinsatzes usw.

2.)
Die Aktivierung/Deaktivierung von Ausrüstungsgegenständen ist zwar schon von Jim vorbereitet worden (der Haken im Editor existiert schon), aber noch nicht vollständig umgesetzt. Außerdem soll es in einer der nächsten Versionen möglich sein, einem Alien gezielt Ausrüstung zuzuordnen (noch nicht festgelegt wann das kommt, hängt auch vom Aufwand ab).
Für diese Funktion müssen diejenigen Dateien dokumentiert werden, in denen die Ausrüstung definiert wird, wo die Skriptbefehle verarbeitet werden und wo die Bodeneinsatz-Einheiten (speziell Aliens) ihre Ausrüstung zugeordnet bekommen.
Zur Info: GameFigureManager.pas enthält die Steuerung die Aliens ihre Ausrüstung zuordnet, und ruft Funktionen der Lagerliste.pas auf um die jeweiligen Daten und Verfügbarkeit zu prüfen.
Wo die Skriptbefehle stecken habe ich zeitlich noch nicht suchen können...


Also lasst Euch bitte von fehlenden Rückmeldungen aus dem Team nicht davon abhalten, mit der Codeanalyse weiterzumachen - und lasst das auch nicht Sento alleine machen. Jede Hilfe aus der Community beschleunigt den Übergang in der Programmierung und reduziert die Zeit bis zur nächsten Version...
verfasst am: 24.11.2006, 17:16
Registrierdatum: 13.04.2005, 16:36

 Beiträge: 618
also es wär schon schon echt gut wenn sich wer finden würde, eine oder zwei überprüfungen wollt ich halt noch dir überlassen damit man eine bespielvorlage hat, und damit ich weis das mir nicht irgendein fehler unterlaufen ist, oder ich was übersehn habe. Ich will dann noch eine beispilseite machen wo drinsteht was ich alles verändert habe damit leute die einsteigen gleich eine anleitung haben.
verfasst am: 24.11.2006, 17:43
Admin, Spielsatz GalWar

Registrierdatum: 31.08.2005, 21:51

 Beiträge: 5595
OK, dann überprüfe ich die bisherigen Sachen - allerdings ist bei den API-Dateien auch nicht soviel falsch zu machen, kritisch wird es wenn es in die Komponentendateien mit ihren mal über Klassen und Objekte querverknüpften und mal einzelnen Funktionen geht ;-)

Nicht mehr dieses Wochenende, aber irgendwann nächste Woche kommt dann die Überprüfung...
verfasst am: 29.12.2006, 03:56
Registrierdatum: 13.04.2005, 16:36

 Beiträge: 618
die andere sache weswegen ich momentan wenig mach (neben schatz und meinem neuem lieblingsspiel (entropia universe)) ist halt auch das ich wirklich keine lust habe alleine zu arbeiten, mag villeicht doof klingen weil man die sachen eh alle alleine bearbeitet ist aber so, außerdem ist es kompliziert mit der gegenkontrolle so ;)
verfasst am: 29.12.2006, 07:17
Admin, Spielsatz GalWar

Registrierdatum: 31.08.2005, 21:51

 Beiträge: 5595
Ich kenne das selber, manchmal hat man einfach keine Lust auf bestimmte Arbeiten...

Ich muss momentan ein paar andere Sachen vorziehen und mich dann bei X-Force erst noch um einen anderen Bereich kümmern, aber danach werde ich mich auch selber mit der Programmanalyse beschäftigen.

Es wäre zwar nett wenn es vorher schon etwas weiter käme, aber ansonsten können wir uns nächstes Jahr (Wahrscheinlich ab Februar) mit vereinten Kräften darauf stürzen...
verfasst am: 29.12.2006, 17:32
Registrierdatum: 13.04.2005, 16:36

 Beiträge: 618
mal schaun villeicht taucht ja arnel wieder auf oder wer anders, der lust hat, laufen ja soviele leute im forum rum... wäre blöd wenn das an dir hängenbleibt du hast eh einiges zutun...
verfasst am: 23.02.2007, 21:38
Admin, Spielsatz GalWar

Registrierdatum: 31.08.2005, 21:51

 Beiträge: 5595
Leider klappt das ja nicht so gut mit einer allgemeinen Dokumentation, deshalb ändere ich die Vorgehensweise etwas:

Ich gebe spezifische Code-Themen vor, die als nächstes zur Bearbeitung und Fehlerbehebung anstehen. Diese spezifischen Codestellen sollten dann gesucht und im Wiki dokumentiert werden.

Wie schon gesagt werde ich in ca. 6 Wochen mit den Arbeiten an der 910Beta anfangen. Wenn dann schon einige der genannten Bereiche dokumentiert sind, kann ich dort direkt mit den Arbeiten anfangen. Sollten die dann noch nicht dokumentiert sein, dann muss ich die betreffenden Codezeilen selber suchen und analysieren, d.h. in diesem Fall müsst ihr mehrere Wochen extra auf die 0910Beta warten.


Als nächstes wird benötigt:
- Wo im Spielprogramm werden die Tile- und Kartendateien geladen und verwaltet?
- Wo befinden sich die Routinen zur Berechnung eines Angriffes, inklusive Kollisionsabfrage mit Wänden und Definition der Range-Effekte (Explosion und Splitter)?
- Wo befindet sich die Zeitsteuerung und das Ereignissystem des Geoscapes?

Ich hoffe es finden sich ein paar Leute die in den nächsten Wochen vorarbeiten zu den Punkten erledigen, dann habe ich es mit der 0910Beta deutlich einfacher und kann die schneller fertig stellen ;-)



Du musst dich registrieren um auf dieses Thema zu antworten.
Login :: » Name » Passwort

Ladezeit (sec.): 0.029 · Powered by miniBB 1.6 with parts of 1.7 © 2001-2003