how to put a Description in about a method

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

Guest

I created an assembly and I wanted to put in a description about each method,
so when other developers choice that method in their projects they will see
the description I put in and will tell them what the method should be used
for.

It seems like a very easy thing, but I can't find the syntax anywhere on how
to do it.

Thanks
Ian
 
idalton said:
I created an assembly and I wanted to put in a description about each method,
so when other developers choice that method in their projects they will see
the description I put in and will tell them what the method should be used
for.

It seems like a very easy thing, but I can't find the syntax anywhere on how
to do it.
Click to expand...

If you're using C#, look up "XML documentation" in MSDN. If you're
using VB.NET, XML documentation isn't part of the current version of
VB.NET but there are plugins available to add it.

Once you've written the XML docs, you need to create the XML file
itself when you build - for C#, this is in the project properties
dialog. You should name your documentation file the same as the
assembly, but with .xml instead of .dll as the extension. Put it in the
same directory as the assembly, and VS.NET will automatically pick up
the docs when you add a reference to the assembly, I believe.
 
Back
Top