Ostrzeżenie dla kompilatora CS1591: Jak wyświetlić to ostrzeżenie tylko dla nieudokumentowanych metod?

Question

C# kompilator pokazuje ostrzeżenie (CS1591), jeżeli członek publiczny jest nieudokumentowane:

Ostrzeżenie ... Brakujący komentarz XML dla typu publicznie widoczne lub członek ...

, który zawiera wszystkie właściwości, metody, klasy, wartość wyliczenia itp.

Pytanie: Czy istnieje sposób skonfigurowania tego typu ostrzeżenia do oznaczania tylko nieudokumentowanych metod? Używam Visual Studio 2010 Ultimate i ReSharper 8.2.

przykład:

public class MyClass // warning 
{ 
    public MyClass(int x) { ... } // warning 

    public void DoSomething() { ... } // warning 

    public int MyProp { get; private set; } // prevent this warning 
} 

public enum MyEnum // warning 
{ 
    X = 0, // prevent this warning 
    Y = 1 // prevent this warning 
} 

Answer 1

Nie istnieje żaden sposób. Ostrzeżenie jest generowane, jeśli podano opcję /doc. Ta opcja nie ma żadnych parametrów do udokumentowania tylko metod. W ten sposób sprawdzany jest każdy wpis dodany do dokumentacji.

Możesz jednak wyłączyć ostrzeżenie z pragma warning, ale nie jest to bardzo wygodne IMO, nawet jeśli grupujesz pola i właściwości.

Answer 2

Możesz go wyłączyć dla całego zespołu, jeśli chcesz.

Właściwości Project> Budowanie kartę> Wyłącza ostrzeżenia: 1591

źródło: https://stackoverflow.com/a/13414522