Kopfkommentar

[proser]

Was haltet ihr von einem einheitlichen Kommentar im Kopf jeder XML-Datei (von wegen Übersicht und so)?

Z.B.:

Code:

<!--

Aufgerufen von: start.xml
Ruft auf: 1.xml, 2.xml, 3.xml

-->

In "start.xml" könnten noch mehr Infos untergebracht werden:

Code:

<!--

Titel: Der große Reset
Autor: Community-Content (Beitrag zum Wettbewerb 2008 von proser)

Start-Ort: Quastenbroich
Stufen-Restriktion: 0-400
Stufen-Empfehlung: 201-201
Maximale APs: 3
Kurz-Inhalt:  Der Held findet einen großen Knopf und drückt ihn.

Änderungshistorie (Name/Datum):
- Erst-Implementierung, xyz/tt.mm.2008

-->

Oder so ähnlich...

[Aidan]

Hmm also die Info mit den Dateien ist nicht schlecht.

Aber in die Start.xml würde ich dann nicht unbedingt die ganzen Zusatzinformationen schreiben.

Wie wäre es stattdessen mit einer Info.xml wo das alles drin steht?

[Gaddezwerch]

Die Kommentare sollten an Ort und Stelle untergebracht werden, ein bisschen was über Auftreten und Wahrscheinlichkeit in der start.xml und was eben so wichtig ist, bei den anderen Dateien. Dokumentiert, was nötig ist, aber eine seperate Datei wäre zu viel des Guten und ist vom Handling ungünstig.