Metadata / Attribute tags ... Questions about creating designer friendly methods

  • Thread starter Thread starter Guest
  • Start date Start date
G

Guest

Lets say you open visual studio .net and do the following

uint s = 100
s. // This now gives you all the methods avaiable to this object. And underneath the methods signature, there is a short description of what the method will do. My question is, when making my own classes and methods, how can I add my own descriptions of what the methods do? From what I have been able to dig up, I believe it has something to do with metadata tags? Or do I have to use comments above my methods similar to java docs....

Thanks

Dan
 
Dan said:
Lets say you open visual studio .net and do the following:

uint s = 100;
s. // This now gives you all the methods avaiable to this object. And
underneath the methods signature, there is a short description of what
the method will do. My question is, when making my own classes and
methods, how can I add my own descriptions of what the methods do?
From what I have been able to dig up, I believe it has something to do
with metadata tags? Or do I have to use comments above my methods
similar to java docs....?
Click to expand...

Look up XML documentation in MSDN. When you've given XML documentation
to your code, make VS.NET generate the XML file itself (under build
configuration somewhere - it's pretty easy to find) and then possibly
use NDoc (http://ndoc.sf.net) to create readable documentation (web
pages or whatever).

To "see" the XML documentation when using the assembly from other
projects/solutions, name the XML file exactly the same as the DLL but
without the .dll part, just putting .xml at the end (e.g.
mycompany.somename.xml) and keep it in the same directory as the DLL.
 
Thanks for the information Jon. I was able to find what I needed after being told what to look for :

-- Dan
 
Back
Top