Home Dashboard Directory Help
Search

Support for XML Documentation in native C++ code by Adam Badura


Status: 

Closed
 as Fixed Help for as Fixed


3
0
Sign in
to vote
Type: Suggestion
ID: 603872
Opened: 9/23/2010 2:09:12 AM
Access Restriction: Public
0
Workaround(s)
view

Description

XML Documentation supports native C++ without templates. So in fact it does not support modern C++ code.

The problem is even larger as not only documentation on templates is not supported but having it leads to undefined behavior so even people satisfied with structured documentation in the code and no need for its advanced uses cannot use it with templates. (Another issue would be lack of template-specific tags.)

I hoped this will change in Visual Studio 2010 but as it appears it did not. Is this going to be changed? If so then when?

If not then just removing the "undefined behavior" and adding tags for templates support (so that documentation can be written now but used later when support will be ready or by external tools) would be an improvement too.


See also forum thread: http://social.msdn.microsoft.com/Forums/en-US/vcgeneral/thread/41ea47ec-10eb-406d-b5c2-6bde62fb66c8/.
Details
Sign in to post a comment.
Posted by Microsoft on 3/21/2011 at 9:59 AM
Hi,

We also have plans to improve XML doc comments on native code, specifically on template code. However, there are lots of features related to XML Doc comments missing from IntelliSense currently that we need to focus our efforts first. We'll consider improving XML Doc comments in a future release.

Thanks,
Ulzii Luvsanbat
Windows C++ Team
Posted by Microsoft on 2/28/2011 at 8:49 AM
Hello,

Thank you for your feedback. XML Doc comments is supported for native C++, you can pass /doc to non-managed C++ code and expect XML comments to be generated.

Thanks,
Ulzii Luvsanbat
Windows C++ Team
Posted by Microsoft on 9/23/2010 at 2:11 AM
Thank you for your feedback, we are currently reviewing the issue you have submitted. If this issue is urgent, please contact support directly(http://support.microsoft.com)
Sign in to post a workaround.