Jump to content
  • Advertisement
Sign in to follow this  
karwosts

VC++ 2010 Express, XML Comments and Intellisense

This topic is 2656 days old which is more than the 365 day threshold we allow for new replies. Please post a new topic.

If you intended to correct an error in the post then please contact us.

Recommended Posts

I've been looking to add a bit of documentation to my project, and trying to see if there's any way to get any helpful information out of intellisense. I read up a little bit about XML documentation, and found the switch to have VC++ generate the .xml file when the code is compiled. I saw this bit in the MSDNwhich has made me curious:


In Visual C++, you can add comments to your source code that will be processed to an .xml file. This file can then be the input to a process that creates documentation for the classes in your code. An .xml file can also be used to support IntelliSense on your component.[/quote]

Does this bold sentence mean anything in layman's terms? I've tried searching around and I get mixed messages everywhere, to some people saying intellisense can load the .xml if it is the same name as the generated .exe, and others saying it won't do anything without a plugin (unavailable to Express versions).

I did a simple test with a tiny bit of code:

class GfxDevice {
///<summary>
///GetD3DDevice:
/// Returns the d3d9 device
///</summary>
LPDIRECT3DDEVICE9 GetD3DDevice();

};


and compiled it to see if I got anything interesting, but I'm pretty underwhelmed.

Hovering over the function (GetD3DDevice) doesn't display any of the comment, and if I type


GfxDevice gfxDev;
gfxDev.GetD3DDevice


and pause there, it gives me this popup:

public GfxDevice::GetD3DDevice
<summary>
GetD3DDevice:
Returns the d3d9 device
</summary>
File GfxDevice.h
[/quote]

which obviously isn't really doing anything with the xml tags, it just spits out the comment that precedes the function. Is there any way to get better documentation/popup help from visual studio, or should I just resign myself to the fact that it won't ever display any documentation on tooltip hover (which is probably when I would like it the most).

Share this post


Link to post
Share on other sites
Advertisement
Sign in to follow this  

  • Advertisement
×

Important Information

By using GameDev.net, you agree to our community Guidelines, Terms of Use, and Privacy Policy.

We are the game development community.

Whether you are an indie, hobbyist, AAA developer, or just trying to learn, GameDev.net is the place for you to learn, share, and connect with the games industry. Learn more About Us or sign up!

Sign me up!