The C# compiler shows a warning (CS1591), if a public member is undocumented:
Warning ... Missing XML comment for publicly visible type or member ...
That includes all properties, methods, classes, enum value, etc.
Question: Is there a way to configure that type of warning to only mark undocumented methods? I use Visual Studio 2010 Ultimate and ReSharper 8.2.
Example:
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
}
You can disable it for the entire assembly if you wish.
Project Properties > Build tab > Suppress warnings: 1591
source: https://stackoverflow.com/a/13414522
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With