Whenever you create a project in Visual Studio, you can create a XML documentation file for the project. It is very simple, you just have to check a box in the Build tab on the project properties screen.
Having done that, you might run into problems. Many a times your project is bound to have some auto generated code like a service reference etc. Now, most of these tools like the svcutil tool does not add comments to the auto generated code, in this situation about 100+ warnings start to appear whenever you build your project.
The warning typically says:
Missing XML comment for publicly visible type or member …
To avoid this situation you can either
- Document the auto generated code
- Disable the warning
#pragma warning disable 1591
/* Any code that you do not want to have XML comment */
#pragma warning restore 1591