C# - XML-Dokumentation nicht von einem anderen Projekt verfügbar

Ich arbeite an einer ASP.NET-Website. Zu der Lösung habe ich ein weiteres Projekt hinzugefügt, das als Data Access Layer (DAL) dient. Wann immer ich das Projekt erstelle, wird die DLL-Datei auf die neue im Website-Projekt aktualisiert. Ich habe XML-Kommentare vor jeder Methode in allen Klassen der DAL eingefügt. Aber sie sind nicht verfügbar, wenn ich die Methodennamen dieser Ebene eintippe. Sie sind jedoch von ihrem eigenen Projekt aus sichtbar. Ist die XML-Dokumentation nur intern? Wenn ja, wie kann ich XML-Kommentare anderer Klassen sehen?C# - XML-Dokumentation nicht von einem anderen Projekt verfügbar

Quelle

2012-04-06 Mikayil Abdullayev

Sie wirklich meinen, die "Website" Variation von ASP.NET? Ie nicht Webanwendung? –

Ist in Ihrem DAL-Projekt die Option "XML-Dokumentationsdatei" auf der Registerkarte "Erstellen" der Projekteigenschaften aktiviert? –

@SergeyRybalkin - in einer normalen Lösung, die nicht für IntelliSense erforderlich ist. –

Zuerst müssen Sie die XML-Dokumentationsdatei für die Ausgabeerstellungseinstellung überprüfen. (Eigenschaften für Ihr Projekt) Dann generieren Sie die XML-Dokumentation, die das andere Projekt verwendet, wenn Sie eine Referenz hinzufügen.

Es gibt 2 Möglichkeiten, die Sie wahrscheinlich die Referenz hinzufügen.

1.) Durch die Wahl „hinzufügen Referenz“ und dann „Projekt“

Diese Methode sollte funktionieren ... wie Sie die Kommentare der anderen Projekt sollte Pickup automatisch die Änderungen aktualisieren.

2.) Durch die Wahl „hinzufügen Referenz“ und dann „DURCHSUCHEN“ ...

Wenn Sie es auf diese Weise tat dann müssen jedes Mal, wenn die XML-Datei ändert sich das Projekt entladen und laden für es um die Änderungen zu übernehmen, oder Sie können Visual Studio neu starten, die das gleiche erreichen wird.

sollten Sie Version 1 verwenden ... In Bezug -> Projekt

Quelle

2012-04-06 11:57:16

Ich habe die Referenz zu meinem DAL-Projekt durch Durchsuchen hinzugefügt, so dass die Aktualisierungsdatei auch generiert wird. Nach einiger Zeit kann ich nun die XML-Dokumentation für meine Objekte sehen. Aber wenn ich überprüfe, um XML-Datei in Build zu generieren, erhalte ich Warnungen für alle Elemente in meinem Projekt, die nicht XML-dokumentiert sind. Gibt es eine Möglichkeit, diese Warnungen zu vermeiden? –

können Sie "#pragma warning disable" in jeder der Dateien verwenden, die Sie in der Warnung unterdrücken möchten ... siehe: http://msdn.microsoft.com/en-us/library/441722ys(v=vs.80) .aspx –

Das hat bei mir funktioniert. Ich hatte XML-Dokumentation von einem anderen Projekt in der gleichen Lösung nicht während der Bearbeitung angezeigt. Ich hatte zuvor die Referenz mit Methode 2 ("Add Reference" -> BROWSE) hinzugefügt. Die Umstellung auf Methode 1 ("Referenz hinzufügen" -> "Projekt") funktioniert. Interessanterweise funktionierten alle anderen Dinge, nur die Dokumentation nicht. Die zweite Methode für das Projekt in verschiedenen Lösungen funktioniert gut (es ist möglicherweise die einzige Option?). – jmc

C# - XML-Dokumentation nicht von einem anderen Projekt verfügbar

Antwort

Verwandte Themen