2012-08-05 7 views
8

Ich erstelle das Dokument eines VS 2010 C# -Projekts mit dem Sandcastle-Hilfedatei-Generator. Ich habe die .xml Dokumentation, die vom Compiler und der Visual Studio-Lösung .sln Datei des Projekts erstellt wurde, zu den Dokumentationsquellen hinzugefügt. Ich habe auch die Projektdatei .exe zu Referenzen hinzugefügt. Es baut jedoch nicht. Ich bekomme es Warnungen und Fehler:Sandcastle Help File Builder Dokumentationsquelle kann nicht gefunden werden

SHFB: Warnung BE0006: kann nicht für ‚C keine Dokumentation Quellen finden: \ Benutzer \ Benutzer \ Music \ Documents \ Visual Studio 2010 \ Projects \ SFML_Platformer \ SFML_Platformer.sln '(Konfiguration: Debug Plattform: AnyCPU)

SHFB: Fehler BE0042: Sie müssen mindestens eine Dokumentation Quelle in Form einer Baugruppe oder einem Visual Studio-Lösung/Projektdatei

angeben Was ist Problem?

+0

Ist 'SFML_Platformer.sln' Ihre Dokumentationslösung oder die Lösung, für die Sie eine Dokumentation erstellen möchten? Wenn es Letzteres ist, versuchen Sie, '.csproj' anstelle von' .sln' hinzuzufügen. Übrigens müssen Sie das XML nicht zu den Dokumentationsquellen hinzufügen. Noch müssen Sie die exe als Referenz hinzufügen. –

Antwort

8

Sie sollten die XML-Dokumentationsdateien nur als Dokumentquelle hinzufügen. Die DLLs werden automatisch hinzugefügt, nachdem Sie die XML-Dateien hinzugefügt haben.

2

Hier die Antwort von Eric a.k.a EWoodruff der Entwickler von Sandcastle Help File Builder.

BE0006 bedeutet, dass die Dokumentationsquelle basierend auf dem Projekt nicht gefunden werden konnte. BE0042 ist ein sekundäres Ergebnis dieser Bedeutung es gefunden nichts zu dokumentieren. Welche Art von Projekten sind in der Lösung? Wenn es sich um ein Website-Projekt handelt, beachten Sie, dass sie normalerweise keine Assemblys erstellen, die als Ausgabe im -Projekt aufgelistet sind, und auch keine XML-Kommentardateien. In diesem Fall müssten Sie Ihrem Projekt die Webcodeanbieter hinzufügen, um die XML-Kommentare abzurufen, und manuell den Ordner. \ Bin der Website als Dokumentationsquelle in das SHFB-Projekt einfügen. Es gibt ein Thema zum Dokumentieren von Websites im Abschnitt Erste Schritte, wenn dies der Fall ist.

Alle anderen Projekttypen sollten funktionieren. Wenn alles andere fehlschlägt, fügen Sie die Assembly und die XML-Kommentardateien direkt hinzu. Ich nehme an, es ist möglich die Express-Editionen verwenden unterschiedliche Projekttyp-IDs. Wenn Sie mir die Lösungsdatei und die Projektdatei senden können, kann ich sie mir ansehen und sehe , warum es die Ziele nicht findet. Meine E-Mail-Adresse befindet sich im Feld About in der eigenständigen GUI und in der Fußzeile der Seiten in der Hilfedatei .

Eine andere Sache, stellen Sie sicher, dass die Konfiguration und Plattform-Einstellungen in der SHFB Symbolleiste ausgewählt entsprechen die Konfiguration und Plattform Einstellungen verwendet, um Ihr Projekt zu erstellen (zB Debug/AnyCPU, Release/AnyCPU, Debug/x86, usw.) . Wenn nicht, wird das nicht dazu führen, dass die richtigen Ausgabeziele finden.

Eric

source

0

ich dieses Problem hatte auftreten, wenn ich das Projekt der Bau in VS.NET auf meinem Haupt-Anwendung Debug-Release geschaltet. Ich nehme an, dass es die .dll nicht mehr finden konnte, die ich angegeben hatte, um die Dokumentation zu erstellen. Ich hätte das Mapping korrigieren können, aber es ging mir gut, diesen Fehler zu beheben, indem ich auf zurückging.

0

Vergessen Sie nicht, Ihre Lösung nach der Reinigung neu zu erstellen, bevor Sie Build in Sandcastle ausführen.