Home | Contact Us | FAQ | Search & Site Map | Link to Us
Sign In | Join | Other 45 Sites in Network
HomeAnnouncementsFree MagazinesWhite PapersSubmit Content
Discussion GroupsASP.NETWindows FormsLanguages.NET FrameworkVisual Studio.NET
Articles.NET FrameworkASP.NETToolsWindows Forms
.NET DirectoryOpen Source ProjectsUser GroupsWeb Resources
Related Topics
Visual Basic 6SQL ServerMS AccessOther DB ProductsMS Server ProductsMore Topics ...

.NET Forum / .NET Framework / New Users / December 2004

Tip: Looking for answers? Try searching our database.

how to put a Description in about a method

Thread view: 
Enable EMail Alerts  Start New Thread
Thread rating: 
idalton - 31 Dec 2004 19:31 GMT
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
Jon Skeet [C# MVP] - 31 Dec 2004 19:38 GMT
> 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
[quoted text clipped - 3 lines]
> It seems like a very easy thing, but I can't find the syntax anywhere on how
> to do it.

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.

Signature

Jon Skeet - <skeet@pobox.com>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too

idalton - 31 Dec 2004 19:47 GMT
I am using VB.Net. What are the plugins and where can I download them from.

Thanks
Ian

> > 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
[quoted text clipped - 14 lines]
> same directory as the assembly, and VS.NET will automatically pick up
> the docs when you add a reference to the assembly, I believe.
Richard Blewett [DevelopMentor] - 31 Dec 2004 20:05 GMT
I always find a tool called google.com useful in this situation.

Surf to http://www.google.com and type in

VB.NET "XML Comments"

in the search textbox. I think there are 4 different tools on the first page of results.

Regards

Richard Blewett - DevelopMentor
http://www.dotnetconsult.co.uk/weblog
http://www.dotnetconsult.co.uk

  I am using VB.Net. What are the plugins and where can I download them from.

Thanks
Ian

Rate this thread:







Free Magazines

Get these publications absolutely FREE for up to 12 months. There are no hidden fees and no obligation. Simply choose a title, complete the application form and submit it. Read more ...

Oracle MagazineNetwork ComputingComputer WorldBio-IT WorldeWeekInformation WeekInfosecurity
 
Sign In
Join
My Latest Posts
My Monitored Threads
My Blog
My Photo Gallery
My Profile
My Homepage

Start New Thread
Enable EMail Alerts
Rate this Thread



©2008 Advenet LLC   Privacy Policy - Terms of Use
This website includes both content owned or controlled by Advenet as well as content owned or controlled by third parties.