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

Jon Skeet's Antwort funktioniert gut, wenn Sie mit VisualStudio erstellen. Allerdings, wenn Sie die sln über die Befehlszeile (in meinem Fall war es über Ant) bauen, dann können Sie feststellen, dass msbuild die sln Unterdrückung Anforderungen ignoriert.

Das Hinzufügen dieser Option zur msbuild-Befehlszeile löste das Problem für mich:

/p:NoWarn=1591

Answer 2

#pragma warning disable 1591
#pragma warning disable 1591
#pragma warning disable 1572
#pragma warning disable 1571
#pragma warning disable 1573
#pragma warning disable 1587
#pragma warning disable 1570

Answer 3

Wird die Warnstufe auf 2 gesetzt, werden diese Meldungen unterdrückt. Ich weiß nicht, ob dies die beste Lösung ist, da dadurch auch nützliche Warnungen unterdrückt werden.

Answer 4

Datei > Modifier > Projekt anzeigen (Klick)

Unten im Dropdown-Bogen (klicken Sie auf Offene/laufende Arbeiten > Eigenschaften ), Öffnen Sie die Projekteigenschaften auf der Seite "Erstellen" unter "Ausgabe". "Uncheck" XML-Dokumentation Kontrollkästchen.

Wiederherstellen und keine Warnungen.

Answer 5

Sie müssen einen /// Kommentar für das Mitglied hinzufügen, für das die Warnung angezeigt wird.

siehe untenstehenden Code

public EventLogger()
{
    LogFile = string.Format("{0}{1}", LogFilePath, FileName);
}

Sie zeigt eine Warnung an Fehlender XML-Kommentar für öffentlich sichtbaren Typ oder Member '.EventLogger()'.

Ich habe einen Kommentar für das Mitglied hinzugefügt und die Warnung ist weg.

///<Summary>
/// To write a log <Anycomment as per your code>
///</Summary>
public EventLogger()
{
    LogFile = string.Format("{0}{1}", LogFilePath, FileName);
}