Wer weiß, ob irgendwo eine XSD-Datei vorhanden ist, die zur Validierung der XML-Dokumentation verwendet werden kann, die beim Kompilieren eines C# -Projekts mit der Option/doc generiert wird?XSD für XML-Dokumentation für C# generiert?
Ich möchte diese Datei manuell ändern, nachdem sie generiert wurde, und ich suche nach einer einfachen Möglichkeit zu bestätigen, dass ich die Struktur der Datei nicht beschädigt habe.
Danke.
Ist heute über diese alte Frage gestolpert. Ich habe das nicht gesehen, indem ich Microsofts Dokumentation angeschaut habe, noch bei anderen Projekten, von denen ich dachte, dass sie ein Interesse daran hätten, ein solches Schema zu entwickeln; nämlich die Quellen für die Sandcastle und (lange nicht existierenden) NDoc Projekte.
Kurz zurücktreten, um zu versuchen, ein eigenes Schema zu definieren, eine Sache, die ich vorschlagen könnte, wäre, eines der vielen Tools zu verwenden, die ein XSD von XML generieren. Microsoft enthält XSD.EXE als Teil von Visual Studio und seinen SDKs.
Sie könnten eine Dummy-Quelle schreiben, die die XML-Dokumentationskommentar-Tags ausführt, die XML-Dokumentationsdatei dafür erstellen und dann XSD.EXE verwenden. um daraus ein XSD zu generieren und es zu verwenden, um das XML-Dokument zu validieren, nachdem Ihre Verarbeitung abgeschlossen ist. Aber ich denke, das könnte sich als weniger trivial erweisen, als es sich anhört.
XML-Dokumentationskommentare beziehen sich auch auf Typen und Codeelemente, und es gibt viele Dinge, die ein Schema nicht erfassen kann. B. überprüfen, ob das name-Attribut eines <param>-Tags immer noch auf einen tatsächlichen Parameternamen in Ihrer C# -Quelle verweist. Der Compiler überprüft solche Elemente zum Zeitpunkt der Erstellung. Wenn Sie die XML-Dokumentation jedoch nachbearbeiten, benötigen Sie ein benutzerdefiniertes Tool, das einen Verweis auf die ursprüngliche C# -Quelle oder generierte Assemblys enthält, um solche Verweise erneut zu überprüfen.
Ich brach schließlich hin und schrieb ein: XSD for Xml Comments for .NET Documentation
Ich weiß, dass dies eine alte Antwort ist, aber ich versuche, eine Dokumentation über das Format des Attributs name des Member Elements zu finden. Ich sehe die Regex, aber ich suche nach einer Dokumentation, wie das zu interpretieren ist. – Jeremy
nicht unbedingt Ihre Frage nicht beantworten, aber hier ist [eine empfohlene Tag-Liste] (http://msdn.microsoft.com/en-us/library/5ast78ax. aspx) mit Links zu Anwendungsbeispielen. HINWEIS: Sie können anwendbare Visual Studio-Versionen auf der Seite auswählen. – Steven