What is the actual question? Would you like to know another way to disable the warnings that are generated when the XML comments are missing? In the project's properties change to the 'Build' tab and uncheck 'XML documentation file'.
For a long time, I had the (good?) habit to document all my public API’s. But keeping the documentation up-to-date has always been a long and boring task.
After a discussion with my fellow developers, I decided to stop adding documentation. Most developers said they don’t look at the documentation but just read the code or have a look at my unit tests to understand what’s going on.
After removing all the documentation, I’m left with a long list of warnings inside my application complaining about ‘Missing XML comment for publicly visible type or member’ .
How to remove these warnings?
There are 2 ways to remove these warnings:
- Turn off the comment generation:
- Go to the Project properties(Right click on your project and choose Properties from the context menu)
- Go to the Build tab
- Uncheck the XML documentation file checkbox
Visual Studio C++ Xml Comments
- Repeat this for every project in your solution
- Disable the warning:
- Go to the Project properties(Right click on your project and choose Properties from the context menu)
- Go to the Build tab
- Add 1591 to the Suppress warnings textbox
- Repeat this for every project in your solution
The XML Document Generator Tool property page exposes the functionality of xdcmake.exe. xdcmake.exe merges .xdc files into an .xml file when your source code contains documentation comments and /doc (Process Documentation Comments) (C/C++) is specified,. See Recommended Tags for Documentation Comments for information on adding documentation comments to source code.
Visual Studio For Mac Review
Note
xdcmake.exe options in the development environment (property pages) differ from the options when xdcmake.exe is used at the command line. For information on using xdcmake.exe at the command line, see XDCMake Reference.
Visual Studio Xml Tools
UIElement List
Suppress Startup Banner
Suppress copyright message.
Additional Document Files
Additional directories in which you want the project system to look for .xdc files. xdcmake will always look for .xdc files generated by the project. Multiple directories can be specified.
Output Document File
The name and directory location of the .xml output file. See Common macros for build commands and properties for information on using macros to specify directory locations.
Document Library Dependencies
If your project has a dependency on a .lib project in the solution, you can process .xdc files from the .lib project into the .xml files for the current project.
