XML Doc

  • Thread starter Thread starter Jon Shemitz
  • Start date Start date
J

Jon Shemitz

I'm using the /doc switch, via the VS project properties dialog /
Configuration Properties / Build / XML Documentation File property.

It gives me a warning when a public member does not have a /// comment
- is there any way to suppress this warning (on a per-file basis)
when, say, a big enum like

/// <summary>
/// SystemParametersInfo actions
/// </summary>
public enum SPI
{
GETBEEP = 1,
SETBEEP = 2,
// ...
GETFOCUSBORDERHEIGHT = 0x2010,
SETFOCUSBORDERHEIGHT = 0x2011
}

doesn't have a /// comment for each member? I'd like to avoid adding
an empty /// comment to each enum value ....
 
Jon Shemitz wrote:
[...snip...]
It gives me a warning when a public member does not have a /// comment
- is there any way to suppress this warning (on a per-file basis)
Click to expand...
[...snip...]

You can suppress warnings using the /nowarn compiler switch specifying the
warning numbers. In the Project Properties, you can enter the numbers in the
Configuration Properties (? sorry, I'm using the german version of VS.NET,
so the actual name in you version might be different) - Errors and
Warnings - Suppress Warnigs-Field. But you cannot do this on a per-file
basis, just for the entire project.
 
Back
Top