Das Unterdrücken der Warnungen "wird nie verwendet" und "wird nie zugewiesen" in C #

Ich habe eine HTTPSystemDefinitions.cs-Datei im C # -Projekt, die im Grunde die älteren Windows-ISAPI für den Verbrauch durch verwalteten Code beschreibt.

Dies umfasst den vollständigen Satz von Strukturen, die für die ISAPI relevant sind, nicht alle oder die vom Code verbraucht werden. Bei der Kompilierung verursachen alle Feldmitglieder dieser Strukturen eine Warnung wie die folgende: -

Das Warnfeld 'UnionSquare.ISAPI.HTTP_FILTER_PREPROC_HEADERS.SetHeader' wird niemals zugewiesen und hat immer den Standardwert null

oder

Warnung Das Feld 'UnionSquare.ISAPI.HTTP_FILTER_PREPROC_HEADERS.HttpStatus' wird niemals verwendet

Können diese mit deaktiviert werden #pragma warning disable? Wenn ja, wie lauten die entsprechenden Fehlernummern? Wenn nicht, kann ich noch etwas tun? Denken Sie daran, dass ich nur weiß, was ich für diese Datei tun soll. Es ist wichtig, dass ich Warnungen wie diese aus anderen Dateien sehe.

Bearbeiten

Beispielstruktur: -

struct HTTP_FILTER_PREPROC_HEADERS
{
    //
    //  For SF_NOTIFY_PREPROC_HEADERS, retrieves the specified header value.
    //  Header names should include the trailing ':'.  The special values
    //  'method', 'url' and 'version' can be used to retrieve the individual
    //  portions of the request line
    //

    internal GetHeaderDelegate GetHeader;
    internal SetHeaderDelegate SetHeader;
    internal AddHeaderDelegate AddHeader;

    UInt32  HttpStatus;               // New in 4.0, status for SEND_RESPONSE
    UInt32  dwReserved;               // New in 4.0
}

Ja, diese können unterdrückt werden.

Normalerweise bin ich gegen die Unterdrückung von Warnungen, aber in diesem Fall müssen für Interop-Strukturen unbedingt einige Felder vorhanden sein, auch wenn Sie diese niemals verwenden möchten (oder können). In diesem Fall sollte dies meiner Meinung nach gerechtfertigt sein .

Um diese beiden Warnungen zu unterdrücken, würden Sie normalerweise den fehlerhaften Code korrigieren. Das erste ("... wird nie verwendet") ist normalerweise ein Code-Geruch von Resten aus früheren Versionen des Codes. Möglicherweise wurde Code gelöscht, aber Felder zurückgelassen.

Der zweite ist normalerweise ein Code-Geruch für falsch verwendete Felder. Beispielsweise können Sie den neuen Wert einer Eigenschaft fälschlicherweise in die Eigenschaft selbst zurückschreiben und niemals in das Hintergrundfeld schreiben.

Gehen Sie folgendermaßen vor, um Warnungen für " Feld XYZ wird niemals verwendet " zu unterdrücken :

#pragma warning disable 0169
... field declaration
#pragma warning restore 0169

Um Warnungen für " Feld XYZ ist niemals zugewiesen und hat immer den Standardwert XX " zu unterdrücken , gehen Sie folgendermaßen vor:

#pragma warning disable 0649
... field declaration
#pragma warning restore 0649

Um solche Warnnummern selbst zu finden (dh woher wusste ich, dass 0169 und 0649 verwendet werden), gehen Sie folgendermaßen vor:

• Kompilieren Sie den Code wie gewohnt. Dadurch werden einige Warnungen zu Ihrer Fehlerliste in Visual Studio hinzugefügt
• Wechseln Sie zum Ausgabefenster und zur Build-Ausgabe und suchen Sie nach denselben Warnungen

• Kopieren Sie den 4-stelligen Warncode aus der entsprechenden Nachricht, die folgendermaßen aussehen sollte:

  C: \ Dev \ VS.NET \ ConsoleApplication19 \ ConsoleApplication19 \ Program.cs (10,28): Warnung CS 0649 : Das Feld 'ConsoleApplication19.Program.dwReserved' wird niemals zugewiesen und hat immer den Standardwert 0

Vorsichtsmaßnahme : Laut dem Kommentar von @Jon Hanna sind möglicherweise einige Warnungen angebracht, damit zukünftige Finder dieser Frage und Antwort.

• In erster Linie ist das Unterdrücken einer Warnung mit dem Schlucken von Tabletten gegen Kopfschmerzen vergleichbar. Sicher, es ist manchmal das Richtige, aber es ist keine umfassende Lösung. Manchmal sind Kopfschmerzen ein echtes Symptom, das Sie nicht maskieren sollten, ebenso wie Warnungen. Es ist immer am besten, die Warnungen zu behandeln, indem Sie ihre Ursache beheben, anstatt sie nur blind aus der Build-Ausgabe zu entfernen.
• Wenn Sie jedoch eine Warnung unterdrücken müssen, folgen Sie dem oben beschriebenen Muster. Die erste Codezeile #pragma warning disable XYZKdeaktiviert die Warnung für den Rest dieser Datei oder zumindest bis eine entsprechende #pragma warning restore XYZKgefunden wird. Minimieren Sie die Anzahl der Zeilen, in denen Sie diese Warnungen deaktivieren. Das obige Muster deaktiviert die Warnung für nur eine Zeile.
• Wie Jon erwähnt, ist ein Kommentar, warum Sie dies tun, eine gute Idee. Das Deaktivieren einer Warnung ist definitiv ein Code-Geruch, wenn sie ohne Grund ausgeführt wird. Ein Kommentar verhindert, dass zukünftige Betreuer Zeit damit verbringen, sich zu fragen, warum Sie sie ausgeführt haben, oder sie sogar zu entfernen und zu versuchen, die Warnungen zu beheben.

Eine andere "Lösung", um diese Warnungen zu beheben, besteht darin, die Struktur zu erstellen public. Die Warnungen werden dann nicht ausgegeben, da der Compiler nicht wissen kann, ob die Felder außerhalb der Assembly verwendet (zugewiesen) werden.

Das heißt, "Interop" -Komponenten sollten normalerweise nicht öffentlich sein, sondern internaloder private.

Ich habe VS beauftragt, das Implementierungsskelett für zu generieren, System.ComponentModel.INotifyPropertyChangedund die Ereignisse wurden als Felder implementiert, die die CS0067-Warnungen auslösten.

Als Alternative zu der in der akzeptierten Antwort angegebenen Lösung habe ich die Felder in Eigenschaften konvertiert und die Warnung ist verschwunden .

Dies ist sinnvoll, da die Syntaxzucker für Eigenschaftsdeklarationen in ein Feld plus Getter- und / oder Setter-Methoden (in meinem Fall Hinzufügen / Entfernen) kompiliert werden, die auf das Feld verweisen. Dies erfüllt den Compiler und die Warnungen werden nicht ausgegeben:

struct HTTP_FILTER_PREPROC_HEADERS
{
    //
    //  For SF_NOTIFY_PREPROC_HEADERS, retrieves the specified header value.
    //  Header names should include the trailing ':'.  The special values
    //  'method', 'url' and 'version' can be used to retrieve the individual
    //  portions of the request line
    //

    internal GetHeaderDelegate GetHeader {get;set;}
    internal SetHeaderDelegate SetHeader { get; set; }
    internal AddHeaderDelegate AddHeader { get; set; }

    UInt32 HttpStatus { get; set; }               // New in 4.0, status for SEND_RESPONSE
    UInt32 dwReserved { get; set; }               // New in 4.0
}

C / C ++ - Benutzer müssen (void)var;Warnungen vor nicht verwendeten Variablen unterdrücken. Ich habe gerade festgestellt, dass Sie Warnungen für nicht verwendete Variablen in C # auch mit bitweisen Operatoren unterdrücken können:

        uint test1 = 12345;
        test1 |= 0; // test1 is still 12345

        bool test2 = true;
        test2 &= false; // test2 is now false

Beide Ausdrücke erzeugen in VS2010 C # 4.0- und Mono 2.10-Compilern keine nicht verwendeten Variablenwarnungen.