Sandcastle nicht dokumentiert Eigenschaftszusammenfassungen

Question

Ich benutze heute SandCastle mit der HelpBuilder GUI zum ersten Mal, um eine API von einigen unserer exponierten Funktionen und Eigenschaften zu erstellen. Ich habe /// <summary> ... </summary auf einer Anzahl der Eigenschaften eingeschlossen, in denen ich das Gefühl hatte, dass sie von einer zusätzlichen Dokumentation oder Anwendungsbeispielen profitieren würden.

Wenn ich die Ausgabedatei nach chm baue, sehe ich die zusammenfassenden Beschreibungen überhaupt nicht. Alle Eigenschaftenelemente sind aufgeführt, ihre Beschreibungen sind jedoch leer. Ich habe das Projekt neu erstellt und einige Einstellungen in SandCastle versucht, aber sie werden immer noch nicht angezeigt.

Gibt es etwas Offensichtliches, das ich übersehe? Liest SandCastle Eigenschaftenzusammenfassungen nicht? Oder benötigen Zusammenfassungen ein anderes Schlüsselwort?

Answer 1

Vom Sandcastle Common Issues Hilfeseite:

in Dokumentation fehlt Code Kommentare

standardmäßig alle von einem XML-Dokumentation des Projektes in einer einzigen Datei mit dem Namen, comments.xml zu erwarten. Wenn Sie mehrere XML-Dokumentationsdateien haben, platzieren Sie sie in einem neuen Ordner namens "Kommentare" und passen Sie sandcastle.config an, um stattdessen einen Platzhalter zu verwenden, wie im folgenden Beispiel gezeigt.

<!-- Copy in comments --> 
<component type="Microsoft.Ddue.Tools.CopyFromIndexComponent" 
      assembly="%DXROOT%\ProductionTools\BuildComponents.dll"> 
    <index name="comments" value="/doc/members/member" 
     key="@name" cache="100"> 
    <data base="%SystemRoot%\Microsoft.NET\Framework\v2.0.50727" 
      recurse="false" files="*.xml" /> 

    <data files="Comments\*.xml" /> <!-- This line was modified --> 

    </index> 
    <copy name="comments" source="*" target="/document/comments" /> 
<components> 

Weitere Informationen finden Sie unter this blog post.

Answer 2

Sie haben Visual Studio zu sagen, die XML-Dokumentationsdatei bei der Kompilierung zu generieren: einfach die entsprechende Projekt-Eigenschaft festgelegt, wie hier beschrieben: http://msdn.microsoft.com/en-us/library/vstudio/x4sa0ak0(v=vs.100).aspx

Danach, Sandburg ausgibt „Zusammenfassung“ Kommentare in dem " Beschreibung "Spalte.

Answer 3

Es sieht so aus als ob eine andere Antwort bereits als funktionierend akzeptiert wurde, aber ich werde meine Lösung hinzufügen, da ich das gleiche Problem hatte, aber aus einem anderen Grund.

Wenn Sie die XML-Datei, die Sie als Dokumentationsquelle verwenden, öffnen, steuern Sie die Methode/Eigenschaft, für die Sie Kommentare geschrieben haben, aber nicht in Ihrem Sandcast-Dokument angezeigt wird. Wenn Sie die folgende Meldung:

Badly geformte XML-Kommentar für Mitglied ignoriert „M: ...

Dann, wie ich, enthalten Sie wahrscheinlich einige Zeichen, die XML über nicht allzu glücklich war, pflegte ich das.“ & "in einem Kommentar, aber XML wird Sie anschreien, wenn Sie" < "oder"> "auch verwenden. Fixieren Sie Ihren Kommentar und Sie sollten gut gehen!