Ich habe eine XML-Konfigurationsdatei für eine Anwendung und ich frage mich, welcher der beste Weg ist, Dokumentation dafür zu behalten. IE Mögliche Tags, Werte usw.Der beste Weg, Dokumentation für eine XML-Konfigurationsdatei zu behalten?
Gibt es ein Tool, einen Schema-Standard oder eine Übung, der ich folgen sollte?
Viele Menschen verwenden XML-Kommentare (<!-- ... -->) dafür.
Wenn Ihre XML-Datei einem Schema oder einer DTD entspricht, dann wäre dieses Schema oder diese DTD ein guter Platz für Ihre Dokumentation. Andernfalls können Sie Muster bereitstellen.
Wenn Sie Ihr eigenes benutzerdefiniertes Konfigurations-XML-Format gerollt haben, erstellen Sie einfach Ihr eigenes Schema und dokumentieren es dort.
Etwas, das ich nirgendwo anders gesehen habe, aber was Sinn machen könnte: Verwenden Sie ein <comment> Element und ignorieren Sie in Ihrem Parser alles darin. Dies würde ermöglichen, kopier- und präparierte Beispiele in der Konfigurationsdatei zu haben, und Sie könnten sie verschachteln, um verschiedene Punkte in jedem Beispiel zu erklären.
Ich glaube, dass Aaron Digullas Antwort (XML-Kommentare) die einfachste ist. Andernfalls zwei Lösungen:
Wenn Sie das Schema zu steuern, fügen Sie ein <comment> Element (Docbook zum Beispiel tut es).
Wenn Sie nicht, einen Namespace wie http://www.example.org/mynamespaces/doc erstellen und <comment> Elemente in der Datei setzen, die von diesem Namespace Präfix, zum Beispiel <doc:comment> (dies setzt voraus, dass Ihre XML-Validierung systme Elemente in unbekannten Namensräumen ignorieren, wie zur Beispiel, NVDL erlaubt).
Angenommen, die Dokumentation ist ziemlich kurz, dies ist ein gutes Beispiel für KISS. +1. – Richard