.NET XML-Dokumentation Kommentar Include Richtlinie in Sandcastle, die nicht zur Hilfedatei hinzugefügt wird

Question

einen interessanten.Ich dokumentiere eine Methode mit XML-Dokumentationskommentaren in C #.Ich möchte die Richtlinie verwenden, um alle Inhalte einer referenzierten Datei aufzunehmen.Ich dokumentiere einen Code, der eine als XML-Dokument formatierte Zeichenfolge empfängt, und ich möchte die XSD-Datei in die Parameterdokumentation einfügen.

Dies funktioniert in Ordnung, da das von Visual Studio erzeugte XML wie ich erwarte.Hier ist ein Snippet des XML: generasacodicetagpre.

Wenn ich jedoch Sandcastle benutze, um daraus eine Hilfedatei zu generieren, wird der Inhalt der XSD-Datei nicht angezeigt, aber Sandcastle meldet keine Fehler.Ich habe versucht, den Dateinamen als relativ zu verwenden, wo die Hilfedateien ebenfalls sind, d. H.

Aber das Visual Studio klagt jedoch, dass er die Datei nicht finden kann.Ich lege sie in beide Orte und trotzdem erscheint die mitgelieferte Datei nicht.

Alle Ideen?

Answer 1

The include tag is processed at compiler time, so the generated XML file should contain all of its referred contents. Hence you have to put your XSD folder relative to the C# source file, then the compiler won't show any errors. After this, Sandcastle will be able to create the help file from the single XML document.