Pomijanie ostrzeżeń „nigdy nie jest używane” i „nigdy nie jest przypisane” w języku C #

Mam plik HTTPSystemDefinitions.cs w projekcie C #, który zasadniczo opisuje starszy interfejs ISAPI systemu Windows do wykorzystania przez kod zarządzany.

Obejmuje to pełny zestaw struktur związanych z ISAPI, które nie są wszystkie lub które są wykorzystywane przez kod. Podczas kompilacji wszyscy członkowie pola tych struktur powodują ostrzeżenie podobne do następującego: -

Pole ostrzeżenia „UnionSquare.ISAPI.HTTP_FILTER_PREPROC_HEADERS.SetHeader” nigdy nie jest przypisane do i zawsze będzie miało swoją domyślną wartość null

lub

Ostrzeżenie Pole „UnionSquare.ISAPI.HTTP_FILTER_PREPROC_HEADERS.HttpStatus” nigdy nie jest używane

Czy można je wyłączyć za pomocą #pragma warning disable ? Jeśli tak, jakie byłyby odpowiednie numery błędów? Jeśli nie, to czy mogę coś jeszcze zrobić? Pamiętaj, że ja tylko robię to dla tego pliku, ważne jest, żebym zobaczył ostrzeżenia takie jak te pochodzące z innych plików.

Edytować

Przykładowa struktura: -

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
}

Tak, można je stłumić.

Zwykle sprzeciwiam się wygaszaniu ostrzeżeń, ale w tym przypadku struktury używane do interopu bezwzględnie wymagają obecności niektórych pól, nawet jeśli nigdy nie zamierzasz (lub nie możesz) ich używać, więc w tym przypadku myślę, że powinno to być uzasadnione .

Zwykle, aby usunąć te dwa ostrzeżenia, naprawiłbyś niewłaściwy kod. Pierwszy („… nigdy nie jest używany”) to zwykle zapach kodu pozostałości po wcześniejszych wersjach kodu. Być może kod został usunięty, ale pola pozostawione.

Drugi to zwykle zapach kodu dla nieprawidłowo używanych pól. Na przykład możesz niepoprawnie zapisać nową wartość właściwości z powrotem do samej właściwości, nigdy nie zapisując w polu zapasowym.

Aby wyłączyć ostrzeżenia „ Pole XYZ nigdy nie jest używane ”, wykonaj następujące czynności:

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

Aby pominąć ostrzeżenia dla „ Pola XYZ nigdy nie jest przypisane i zawsze będzie miało swoją domyślną wartość XX ”, wykonaj następujące czynności:

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

Aby samodzielnie znaleźć takie numery ostrzeżeń (tj. Skąd wiedziałem, że mam używać 0169 i 0649), wykonaj następujące czynności:

• Skompiluj kod w normalny sposób, spowoduje to dodanie ostrzeżeń do listy błędów w programie Visual Studio
• Przełącz się do okna Wyjście i wyjścia kompilacji i poszukaj tych samych ostrzeżeń

• Skopiuj 4-cyfrowy kod ostrzegawczy z odpowiedniej wiadomości, który powinien wyglądać tak:

  C: \ Dev \ VS.NET \ ConsoleApplication19 \ ConsoleApplication19 \ Program.cs (10,28): ostrzeżenie CS 0649 : Pole „ConsoleApplication19.Program.dwReserved” nigdy nie jest przypisane do i zawsze będzie miało wartość domyślną 0

Uwaga : zgodnie z komentarzem @Jon Hanny , być może kilka ostrzeżeń jest na to potrzebne, dla przyszłych użytkowników tego pytania i odpowiedzi.

• Po pierwsze i najważniejsze, powstrzymywanie ostrzeżenia jest podobne do połykania tabletek na ból głowy. Jasne, czasami może to być właściwe rozwiązanie, ale nie jest to uniwersalne rozwiązanie. Czasami ból głowy jest prawdziwym objawem, którego nie należy maskować, podobnie jak ostrzeżenia. Zawsze najlepiej jest spróbować leczyć ostrzeżenia, naprawiając ich przyczynę, zamiast po prostu usuwać je na ślepo z wyniku kompilacji.
• Powiedziawszy to, jeśli chcesz usunąć ostrzeżenie, postępuj zgodnie ze schematem, który przedstawiłem powyżej. Pierwsza linia kodu #pragma warning disable XYZKwyłącza ostrzeżenie dla pozostałej części tego pliku lub przynajmniej do czasu #pragma warning restore XYZKznalezienia odpowiedniego. Zminimalizuj liczbę wierszy, w których wyłączasz te ostrzeżenia. Powyższy wzór wyłącza ostrzeżenie tylko dla jednej linii.
• Ponadto, jak wspomina Jon, komentarz wyjaśniający, dlaczego to robisz, jest dobrym pomysłem. Wyłączenie ostrzeżenia jest zdecydowanie zapachem kodu, gdy jest wykonywane bez przyczyny, a komentarz uniemożliwi przyszłym opiekunom spędzanie czasu na zastanawianiu się, dlaczego to zrobiłeś, lub nawet na usunięciu go i próbie naprawienia ostrzeżeń.

Innym „rozwiązaniem” naprawienia tych ostrzeżeń jest utworzenie struktury public. Ostrzeżenia nie są wtedy generowane, ponieważ kompilator nie może wiedzieć, czy pola są używane (przypisywane) poza zestawem.

To powiedziawszy, komponenty „interop” zwykle nie powinny być publiczne, ale raczej internallub private.

Dostałem VS do wygenerowania szkieletu implementacji dla System.ComponentModel.INotifyPropertyChangedi zdarzenia zostały zaimplementowane jako pola, które wyzwoliły ostrzeżenia CS0067.

Zamiast rozwiązania podanego w zaakceptowanej odpowiedzi zamieniłem pola na właściwości i ostrzeżenie zniknęło .

Ma to sens, ponieważ cukier składni deklaracji właściwości jest kompilowany do pola plus metody pobierające i / lub ustawiające (w moim przypadku dodaj / usuń), które odwołują się do pola. To spełnia wymagania kompilatora, a ostrzeżenia nie są zgłaszane:

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
}

Użytkownicy C / C ++ muszą (void)var;pomijać ostrzeżenia o nieużywanych zmiennych. Właśnie odkryłem, że możesz również pomijać ostrzeżenia o nieużywanych zmiennych w C # za pomocą operatorów bitowych:

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

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

Oba wyrażenia nie generują nieużywanych ostrzeżeń o zmiennych w kompilatorach VS2010 C # 4,0 i Mono 2,10.