XDCMake Reference

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at XDCMake Reference.

xdcmake.exe is a program that compiles .xdc files into an .xml file. An .xdc file is created by the Visual C++ compiler for each source code file when source code is compiled with /doc and when the source code file contains documentation comments marked up with XML tags.

To use xdcmake.exe in the Visual Studio development environment

  1. Open the project's Property Pages dialog box. For details, see How to: Open Project Property Pages.

  2. Open the Configuration Properties folder.

  3. Click the XML Document Comments property page.

System_CAPS_ICON_note.jpg Note

xdcmake.exe options at the command line differ from the options when xdcmake.exe is used in the development environment (property pages). For information on using xdcmake.exe in the development environment, see XML Document Generator Tool Property Pages.

xdcmake input_filename options

where:

input_filename
The file name of the .xdc files used as input to xdcmake.exe. Specify one or more .xdc files or use *.xdc to use all .xdc files in the current directory.

options
Zero or more of the following:

OptionDescription
/?, /helpDisplay help for xdcmake.exe.
/assembly:filenameLets you specify the value of the <assembly> tag in the .xml file. By default, the value of the <assembly> tag is the same as the filename of the .xml file.
/nologoSuppress copyright message.
/out:filenameLets you specify the name of the .xml file. By default, the name of the .xml file is the filename of the first .xdc file processed by xdcmake.exe.

Visual Studio will invoke xdcmake.exe automatically when building a project. You can also invoke xdcmake.exe at the command line.

See Recommended Tags for Documentation Comments for more information on adding documentation comments to source code files.

XML Documentation

Show: