Fehlender XML-Kommentar für öffentlich sichtbaren Typ oder Mitglied

Question

Ich erhalte diese Warnung: "Fehlender XML-Kommentar für öffentlich sichtbaren Typ oder Mitglied".

Wie lässt sich das Problem lösen?

Answer 1

5 Optionen:

• Ausfüllen der Dokumentationskommentare (großartig, aber zeitaufwendig)
• Deaktivieren Sie die Erzeugung von Kommentaren (in den Projekteigenschaften)
• Deaktivieren Sie die Warnung in den Projekteigenschaften (in "Projekteigenschaften" gehen Sie zu Projekteigenschaften -> Build > "Fehler und Warnungen" (Abschnitt), Warnungen unterdrücken (Textfeld), fügen Sie 1591 (kommagetrennte Liste) hinzu). Standardmäßig wird die Aktive Konfiguration geändert, prüfen Sie, ob Sie die Konfiguration in Alle ändern können.
• Verwenden Sie #pragma warning disable 1591 die Warnung nur für bestimmte Codeabschnitte zu deaktivieren (und #pragma warning restore 1591 danach)
• Ignorieren Sie die Warnungen (schlechte Idee - Sie werden neue "echte" Warnungen verpassen)

Answer 2

Fügen Sie natürlich XML-Kommentare zu den öffentlich sichtbaren Typen und Mitgliedern hinzu :)

///<Summary>
/// Gets the answer
///</Summary>
public int MyMethod()
{
   return 42;
}

Sie brauchen diese <summary> Kommentare zu allen Mitgliedern eingeben - diese werden auch im Popup-Menü der Intellisense angezeigt.

En Grund Sie diese Warnung erhalten, liegt daran, dass Sie Ihr Projekt so eingestellt haben, dass es eine Dokumentations-Xml-Datei ausgibt (in den Projekteinstellungen). Dies ist nützlich für Klassenbibliotheken (.dll-Assemblies), was bedeutet, dass Benutzer Ihrer .dll Intellisense-Dokumentation für Ihre API genau dort in Visual Studio erhalten.

Ich empfehle Ihnen, sich ein Exemplar der GhostDoc Visual Studio AddIn. Macht das Dokumentieren viel einfacher.

Answer 3

Es gibt eine weitere Möglichkeit, diese Meldungen zu unterdrücken, ohne dass eine Codeänderung oder Pragma-Blöcke erforderlich sind. Mit Visual Studio - Gehen Sie zu Projekteigenschaften > Build > Fehler und Warnungen > Warnungen unterdrücken - fügen Sie 1591 an die Liste der Warncodes an.

Answer 4

Warnungen für XML-Kommentare unterdrücken

(nicht meine Arbeit, aber ich fand sie nützlich, also habe ich den Artikel und den Link eingefügt)

http://bernhardelbl.wordpress.com/2009/02/23/suppress-warnings-for-xml-comments/

Hier zeige ich Ihnen, wie Sie Warnungen für XML-Kommentare nach einem Visual Studio Build unterdrücken können.

Hintergrund

Wenn Sie in den Projekteinstellungen von Visual Studio das Häkchen bei "XML-Dokumentationsdatei" gesetzt haben, wird eine XML-Datei mit allen XML-Kommentaren erstellt. Zusätzlich werden Sie auch in den vom Designer generierten Dateien viele Warnungen erhalten, weil XML-Kommentare fehlen oder falsch sind. Während manchmal Warnungen uns helfen, unseren Code zu verbessern und zu stabilisieren, sind Hunderte von XML-Kommentarwarnungen einfach nur nervig.

Warnungen

Fehlender XML-Kommentar für öffentlich sichtbaren Typ oder Mitglied
XML-Kommentar zu hat ein param-Tag für ' ', aber es gibt keinen Parameter mit diesem Namen Der Parameter " " hat kein passendes param-Tag im XML-Kommentar für " " (andere Parameter aber schon)

解決方法

Sie können jede Warnung in Visual Studio unterdrücken.

• Klicken Sie mit der rechten Maustaste auf das Visual Studio-Projekt / Eigenschaften / Registerkarte "Build

• Fügen Sie die folgenden Warnnummern in das Feld "Warnungen unterdrücken" ein: 1591,1572,1571,1573,1587,1570

Answer 5

Fügen Sie einen XML-Kommentar ein. ;-)

/// <summary>
/// Describe your member here.
/// </summary>
public string Something
{
    get;
    set;
}

Dies mag auf den ersten Blick wie ein Scherz erscheinen, aber es kann tatsächlich nützlich sein. Für mich hat es sich als hilfreich erwiesen, darüber nachzudenken, was die Methoden selbst bei privaten Methoden tun (es sei denn, sie sind wirklich trivial, natürlich).