Orcas and XML code documentation

The C# XML Documentation in VS2003/2005 is very nice. It would be nice if ORCAS had inline XML Documentation functionality in native C++ projects (similar to C#). I really don't want to have to use Doxygen to get this functionality. It would be nice if the IDE just supported XML docs out of the box. Does XML doc functionality for native C++ projects exist in Orcas?

thanks

ScottM

[404 byte] By [skmcfadden] at [2008-2-20]
# 1

Hi Scott:

We have some limited support for XML doc comments In VS2005 and Orcas. We support them on CLR projects only (not on native C++ projects). We support reading and displaying XML doc comments from .NET Framework assembly references and from already built CLR C++ project references. Unfortunately, we don't support reading the XML doc comments from a C# / VB project references.

The format for authoring XML doc comments is the same you use in C#. Additionally, you have to enable them in your project by passing the /doc command line option to the compiler. You can find this in the project properties, specifically under C++\Output Files (look for a property called Generate XML Documentation Files).

Boris Jabes, a Program Manager in VCIDE, is currently investigating supporting this on native C++ projects for a future Visual C++ release.. We see the value in having some form of XML documentation available when consuming Windows APIs and when authoring native C++ projects.

Thank you for sharing your suggestion and concerns with us.

Alvin Chardon

AlvinChardon at 2007-10-3 > top of Msdn Tech,Visual Studio Orcas,Visual C++ Orcas...

Visual Studio Orcas

Site Classified