|
dev
newsgroups
|
|||||||||||||||||||||||
|
|||||||||||||||||||||||
Properly commenting mthods and propertiesHello,
i have been wondering for a while how to replicate the helpful pop up boxes that show up when using microsoft classes like DataTable. See if i do datatable.select i get an explanation for each parameters. I just can't find the proper term to search in google. Is it attributes ? If so, how to do that ? I'd like to put proper descriptions of all methods and properties i create. I really spent time searching for that but i just can't seem to find an explanation in google... Thanks in advance for taking the time to answer such a basic question. "/dev/null" <devn***@discussions.microsoft.com> wrote in message I believe it's the xml comments.news:2A56993E-7B23-4CCF-BB73-7C2E8C92B5FF@microsoft.com... > Hello, > i have been wondering for a while how to replicate the helpful pop up > boxes > that show up when using microsoft classes like DataTable. > > See if i do datatable.select i get an explanation for each parameters. > > I just can't find the proper term to search in google. Is it attributes ? > If so, how to do that ? Try typing /// on the line above a class or method, and see if the editor doesn't generate a template comment for you to fill in. Show quote > > I'd like to put proper descriptions of all methods and properties i > create. > > I really spent time searching for that but i just can't seem to find an > explanation in google... > > Thanks in advance for taking the time to answer such a basic question. Thank you.
It seems it is not supported for vb.net under visual studio 2003. I need to investigate a bit more but i'm on the right track i think! Show quote "Ben Voigt" wrote: > > "/dev/null" <devn***@discussions.microsoft.com> wrote in message > news:2A56993E-7B23-4CCF-BB73-7C2E8C92B5FF@microsoft.com... > > Hello, > > i have been wondering for a while how to replicate the helpful pop up > > boxes > > that show up when using microsoft classes like DataTable. > > > > See if i do datatable.select i get an explanation for each parameters. > > > > I just can't find the proper term to search in google. Is it attributes ? > > If so, how to do that ? > > I believe it's the xml comments. > Try typing /// on the line above a class or method, and see if the editor > doesn't generate a template comment for you to fill in. > > > > > I'd like to put proper descriptions of all methods and properties i > > create. > > > > I really spent time searching for that but i just can't seem to find an > > explanation in google... > > > > Thanks in advance for taking the time to answer such a basic question. > > > On Mon, 19 Jun 2006 13:06:02 -0700, /dev/null wrote:
> Thank you. You can't use XML comments, which are needed for intellisense to work, with> > It seems it is not supported for vb.net under visual studio 2003. > > I need to investigate a bit more but i'm on the right track i think! VB 2003. Only works with C#. I think that VB supports XML comments in Visual Studio 2005. You might have better answers in the VB group though. "/dev/null" <devn***@discussions.microsoft.com> wrote in message /// is for C#. In VB.Net it seems to be '''news:572DC436-4FCF-4F57-9CB2-4DA8312210C9@microsoft.com... > Thank you. > > It seems it is not supported for vb.net under visual studio 2003. Show quote > > I need to investigate a bit more but i'm on the right track i think! > > "Ben Voigt" wrote: > >> >> "/dev/null" <devn***@discussions.microsoft.com> wrote in message >> news:2A56993E-7B23-4CCF-BB73-7C2E8C92B5FF@microsoft.com... >> > Hello, >> > i have been wondering for a while how to replicate the helpful pop up >> > boxes >> > that show up when using microsoft classes like DataTable. >> > >> > See if i do datatable.select i get an explanation for each parameters. >> > >> > I just can't find the proper term to search in google. Is it >> > attributes ? >> > If so, how to do that ? >> >> I believe it's the xml comments. >> Try typing /// on the line above a class or method, and see if the editor >> doesn't generate a template comment for you to fill in. >> >> > >> > I'd like to put proper descriptions of all methods and properties i >> > create. >> > >> > I really spent time searching for that but i just can't seem to find an >> > explanation in google... >> > >> > Thanks in advance for taking the time to answer such a basic question. >> >> >> /dev/null,
In addition to the other comments: For VB.NET 2002/2003: VB Commenter URL:http://www.gotdotnet.com/team/ide/ XML Documentation URL:http://www.gotdotnet.com/team/vb/ VBXC - VB.NET XML Commentor URL:http://vbxmldoc.tor-erik.net/ NDOC (formerly DOC.NET) URL:http://ndoc.sourceforge.net/ VB.DOC URL:http://vb-doc.sourceforge.net/ URL:http://www.gotdotnet.com/Community/Workspaces/Workspace.aspx?id=112b5449-f702-46e2-87fa-86bdf39a17dd For VB 2005: http://msdn2.microsoft.com/en-us/ms172653(VS.80).aspx C# XML comments: C# Programmer's Reference -- Recommended Tags for Documentation Comments URL:http://msdn.microsoft.com/library/en-us/csref/html/vclrfTagsForDocumentationComments.asp http://msdn.microsoft.com/msdnmag/issues/02/06/XMLC/ -- Show quoteHope this helps Jay B. Harlow [MVP - Outlook] ..NET Application Architect, Enthusiast, & Evangelist T.S. Bradley - http://www.tsbradley.net "/dev/null" <devn***@discussions.microsoft.com> wrote in message news:2A56993E-7B23-4CCF-BB73-7C2E8C92B5FF@microsoft.com... | Hello, | i have been wondering for a while how to replicate the helpful pop up boxes | that show up when using microsoft classes like DataTable. | | See if i do datatable.select i get an explanation for each parameters. | | I just can't find the proper term to search in google. Is it attributes ? | If so, how to do that ? | | I'd like to put proper descriptions of all methods and properties i create. | | I really spent time searching for that but i just can't seem to find an | explanation in google... | | Thanks in advance for taking the time to answer such a basic question.  |
|||||||||||||||||||||||
Other interesting topics