Ich erstelle das Dokument eines VS 2010 C # -Projekts mit dem Sandcastle Help File Builder. Ich habe die Dokumentation .xml vom Compiler und die Visual Studio-Lösung .sln -Datei des Projekts zu den Dokumentationsquellen hinzugefügt. Ich habe auch die Projektdatei .exe zu Referenzen hinzugefügt. Es baut jedoch nicht. Ich bekomme dort Warnungen und Fehler:
SHFB: Warnung BE0006: Keine Dokumentationsquellen für 'C: \ Benutzer \ Benutzer \ Musik \ Dokumente \ Visual Studio 2010 \ Projekte \ SFML_Platformer \ SFML_Platformer.sln' (Konfiguration: Debug Plattform: AnyCPU)
SHFB: Fehler BE0042: Sie müssen mindestens eine Dokumentationsquelle in Form einer Assembly oder einer Visual Studio-Projektdatei angeben
Was ist das Problem?
Sie sollten nur die XML-Dokumentationsdateien als Dokumentquelle hinzufügen. Die DLLs werden automatisch hinzugefügt, nachdem Sie die XML-Dateien hinzugefügt haben.
Hier die Antwort von Eric a.k.a EWoodruff, dem Entwickler von Sandcastle Help File Builder.
BE0006 bedeutet, dass die Dokumentationsquelle nicht auf der Grundlage der gefunden wurde Projekt. BE0042 ist ein sekundäres Ergebnis dieser gefundenen Bedeutung nichts zu dokumentieren. Welche Art von Projekten sind in der Lösung? Wenn es sich um ein Website-Projekt handelt, beachten Sie, dass dies nicht der Fall ist Produzieren Sie in der Regel alle Assemblys, die in der Liste als Ausgabe aufgeführt sind Projekt noch irgendwelche XML-Kommentardateien. In diesem Fall müssten Sie hinzufügen die Web-Code-Provider zu Ihrem Projekt, um die XML-Kommentare zu erhalten und Fügen Sie den Ordner. \ bin der Website manuell als Dokumentationsquelle hinzu das SHFB-Projekt. Es gibt ein Thema zum Dokumentieren von Websites in der Getting Started, wenn dies der Fall ist.
Alle anderen Projekttypen sollten funktionieren. Wenn alles andere fehlschlägt, versuche es hinzuzufügen die Assembly- und XML-Kommentardateien direkt. Ich nehme an, es ist möglich Die Express-Editionen verwenden unterschiedliche Projekttyp-IDs. Wenn Sie mir schicken können Die Lösungsdatei und Projektdatei kann ich mir anschauen und sehen warum es die Ziele nicht findet. Meine E-Mail-Adresse befindet sich in der Info Box in der Standalone-GUI und in der Fußzeile der Seiten in der Hilfe Datei.
Eine andere Sache, stellen Sie sicher, die Konfiguration und Plattform-Einstellungen in der SHFB-Symbolleiste ausgewählt sind, entsprechen der Konfiguration und der Plattform Einstellungen verwendet, um Ihr Projekt zu erstellen (z. B. Debug / AnyCPU, Release / AnyCPU, Debug / x86, usw.). Wenn nicht, wird das nicht dazu führen finde die richtigen Ausgabeziele.
Eric
Ich hatte dieses Problem, als ich den Build des Projekts in VS.NET in meiner Hauptanwendung von Debug auf Release umstellte. 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 zurück zu Debug zu gehen hat mir gut getan, um diesen Fehler zu entfernen.
Tags und Links c# xml sandcastle documentation shfb