suppress ostrzeżenie dla wygenerowanego kodu C#

Question

Włączyłem "Traktuj ostrzeżenia jako błędy" dla mojego projektu VS, co oznacza, że ​​dostaję błędy za brakującą dokumentację (ładne przypomnienie dla tego konkretnego projektu).

Jednak część kodu jest generowana przez niestandardowe narzędzie, które nie wstawia dokumentacji xml, więc szukam z dala, aby zignorować brakującą dokumentację XML dla wygenerowanego kodu, a nie dla całego projektu. Nie mam wpływu na rzeczywisty wygenerowany plik i nie mogę wstawić niczego w pliku (ponieważ jest on często regenerowany przez narzędzie), więc szukam czegoś poza wygenerowanym plikiem (wygenerowane klasy są częściowe, jeśli to pomaga)

Answer 1

EDYTOWANIE: Zobacz komentarze wskazujące, że ten nie pracy z C# 4. Nie jestem jasne, czy działało we wcześniejszych wersjach kompilatora. Specyfikacja C# 4 czyni to jednak całkiem jasnym. Sekcja 2.5.8.1 stwierdza:

Dyrektywa #pragma warning restore przywraca wszystkie lub podane zestawy ostrzeżeń do stanu, który obowiązywał na początku jednostki kompilacji. Należy zauważyć, że jeśli określone ostrzeżenie zostało wyłączone zewnętrznie, #pragma warning restore (dla wszystkich lub określonego ostrzeżenia) nie włączy ostrzeżenia ponownie.

Jeff ma numer workaround in a blog post - w zasadzie po to, aby ponownie przetworzyć wygenerowany automatycznie kod w ramach kompilacji.

---

Jak mówi Tom, można dodać „ignoruj” do całego projektu (build/Wyłącza ostrzeżenia - wpisać 1591 jako numer ostrzegawczy) - ale wtedy można przywrócić ostrzegając się na szczycie każdego z niewyspecjalizowanych generowane plików:

#pragma warning restore 1591 

to dość brzydki, ale działa (I właśnie przetestowane).

Answer 2

Najlepsze, co możesz zrobić, to pominąć konkretne ostrzeżenie w projekcie, które zawiera wygenerowany kod. Możesz to zrobić w Właściwości projektu na karcie Kompilacja. To nie jest idealne, ale brakuje w nim umieszczenia pragmy w wygenerowanym kodzie, jest to najlepsze, co możesz zrobić.

Answer 3

Najlepszym sposobem, aby uniknąć ostrzeżenia lub błędu Kod analizy na kod generowany jest do dekorowania wygenerowanych klas z GeneratedCodeAttribute i sprawiają, że plik kod kończy się wzór * .generated.cs.

Jeśli pliki kodowe mają również nagłówek pliku, należy miał te tagi:

//---------------------- 
// <auto-generated> 
//  Tool description 
// </auto-generated> 
//---------------------- 

Nie jest to obowiązkowe, ale jeśli masz nagłówek pliku kodu jest to dobra praktyka.

W ten sposób FxCop i inne narzędzia, takie jak StyleCop, nie będą już analizować Twojego kodu.

Nieprawidłowe jest to, że narzędzie generowania kodu nie rozkłada elementów kodu za pomocą wspomnianego powyżej atrybutu. Spróbuj sprawdzić, czy istnieje opcja włączenia w ustawieniach narzędzi lub skontaktuj się z zespołem projektowym.

---

EDIT: Czy wygenerowane klasy są częściowe klas i zrobić rzeczywistą nazwę zajęć i liczba zmienia się często? Ponieważ jeśli wygenerowana zawartość kodu nie porusza się dużo, można po prostu utworzyć inny plik kodu i zadeklarować wygenerowaną klasę częściową, aby udekorować je za pomocą GeneratedCodeAttribute. Raz uratował mi życie (i mój czas!).