Intellisense XML Comments / Documentation

  • Thread starter Thread starter jarnie
  • Start date Start date
J

jarnie

I have the VB 2005 Express Edition, and have been looking at how to add
XML Documentation to my projects. After reading a few articles I have
found, it appears that 2005 introduced native support for it to the VB
language.

The following article:
http://www.pcplus.co.uk/tutorials/software_development/document_your_code_with_xml

....mentioned that to generate comments automatically you simply enter 3
(') on a blank line directly above the procedure/property etc and push
enter to generate an XML skeleton - but when I do it nothing happens.

I have tried manually typing the XML comments in, building the project,
but still they do not appear in the Intellisense assistant. Here is a
sample of what I am trying (in the IDE):

''' <summary>
''' Gets whether the player has qualified for the next round or not
''' </summary>
Public ReadOnly Property Qualified() As Boolean
Get
Return m_Qualified
End Get
End Property

Please let me know how to accomplish this! Thanks,
James Arnold
 
I have tried the code I game as an example in SharpDevelop, and it
works flawlessly there, but still no luck in VB2005 EE. Is there a
setting I need to configure somewhere to enable it? I have looked under
the "Compile" page in the project settings but there is no options for
"Generate XML documentation" is in the full versions.
 
Back
Top