Function definition tips in class or assembly????

  • Thread starter Thread starter Serge Calderara
  • Start date Start date
S

Serge Calderara

dear all,

when I use classes function from framework, I could see a
small tooltips wich is showing parameters to pass to the
function but in addition a brief derscription of each.

When doing my own function, is there a way to display as
well description of each parameters when implementing that
function?

thanks
regards
 
Serge Calderara said:
when I use classes function from framework, I could see a
small tooltips wich is showing parameters to pass to the
function but in addition a brief derscription of each.

When doing my own function, is there a way to display as
well description of each parameters when implementing that
function?
Click to expand...

If you're writing in C#, you can add XML documentation to the methods
etc - and within that XML documentation you can describe the parameters
using the <param> element.
 
To follow up on John's spot on comment, above the function you wish to
document simply type "///". This will cause VS.NET to put the framework
of tags required for building complete documentation that can be used by
VS.NET for intellityping. You will also need to go into your project
properties and under Configuration Properties>Build specify a value for
XML Documentation File. If my project name is TestProject, then I would
set XML Documentation File to \bin\Debug\TestProject.xml. You then
distribute the XML file to developers who will be using your namespace.
If the XML file is in the same directory as the DLL then VS.NET will
show them the comments you added to the functions.

Hope that makes sense.
Rob Epstein
Sr Developer
Auctionworks, Inc.
"Nothing's impossible until proven so" - Me
 
calderara serge said:
Unfortunatly I am using Visual basic.
is there other way?
Click to expand...

Search for
VB.NET XML documentation
on Google - there are lots of hits. I don't know if any of them plug
into VS.NET though.
 
Back
Top