property/method annotation

  • Thread starter Thread starter Craig Buchanan
  • Start date Start date
C

Craig Buchanan

Is there a way to annotate a property or method so that this description is
displayed in the object browser?

Thanks,

Craig Buchanan
 
Hi Craig,

The summary relies on XML comments which are built-in to the IDE for C# but
not for VB.NET. This feature will be added to VB.NET in the v2.0 (Whidbey)

You could try the VBCommenter Power Toy for VS 2003. It's an add-in to VS
2003 that allows you to easily add XML comments and may also compile the
info required by the Object Brower into your assemblies as well.
http://www.gotdotnet.com/team/ide/helpfiles/VBCommenter.aspx
 
Rob-

Can I do this manually in the code? I have seen C# code that uses the
<Summary/> tags, can I use that in VB.Net?

Thanks,

Craig

Rob Windsor said:
Hi Craig,

The summary relies on XML comments which are built-in to the IDE for C# but
not for VB.NET. This feature will be added to VB.NET in the v2.0 (Whidbey)

You could try the VBCommenter Power Toy for VS 2003. It's an add-in to VS
2003 that allows you to easily add XML comments and may also compile the
info required by the Object Brower into your assemblies as well.
http://www.gotdotnet.com/team/ide/helpfiles/VBCommenter.aspx

--
Rob Windsor [MVP-VB]
G6 Consulting
Toronto, Canada


Craig Buchanan said:
Is there a way to annotate a property or method so that this description is
displayed in the object browser?

Thanks,

Craig Buchanan
Click to expand...
Click to expand...
 
Hi Craig,

The <Summary> tags are part of the XML comments I was speaking of.

Rob


Craig Buchanan said:
Rob-

Can I do this manually in the code? I have seen C# code that uses the
<Summary/> tags, can I use that in VB.Net?

Thanks,

Craig

Rob Windsor said:
Hi Craig,

The summary relies on XML comments which are built-in to the IDE for C# but
not for VB.NET. This feature will be added to VB.NET in the v2.0 (Whidbey)

You could try the VBCommenter Power Toy for VS 2003. It's an add-in to VS
2003 that allows you to easily add XML comments and may also compile the
info required by the Object Brower into your assemblies as well.
http://www.gotdotnet.com/team/ide/helpfiles/VBCommenter.aspx

--
Rob Windsor [MVP-VB]
G6 Consulting
Toronto, Canada


Craig Buchanan said:
Is there a way to annotate a property or method so that this
Click to expand...
description
is
displayed in the object browser?

Thanks,

Craig Buchanan
Click to expand...
Click to expand...
Click to expand...
 
Back
Top