GhostDoc Rocks! +1
GhostDoc FTW! Thanks, Shawn Wildermuth Wildermuth Consulting Services, LLC http://adoguy.com C# MVP, MCSD.NET, Author and Speaker -----Original Message----- From: Discussion of advanced .NET topics. [mailto:[EMAIL PROTECTED] On Behalf Of Sean Ferguson Sent: Saturday, June 24, 2006 2:16 AM To: [email protected] Subject: Re: [ADVANCED-DOTNET] Documenting Dlls I know this doesn't help if your using VS2003 and VB.Net, but I was recently shown this tool, GhostDoc (http://www.roland-weigelt.de/ghostdoc/) which is to help generate xml comments in your classes. From what I saw it looked pretty good. Haven't used it myself but intend to. Cheers Sean "Don't take life to seriously, no one gets out alive!" -----Original Message----- From: Discussion of advanced .NET topics. [mailto:[EMAIL PROTECTED] On Behalf Of Eric Means Sent: Saturday, 24 June 2006 3:10 PM To: [email protected] Subject: Re: [ADVANCED-DOTNET] Documenting Dlls Actually, it may have been this one: http://www.gotdotnet.com/Workspaces/Workspace.aspx?id=112b5449-f702-46e2-87f a-86bdf39a17dd instead. Like I said, it was 2+ years ago. ;) On 6/24/06, Eric Means <[EMAIL PROTECTED]> wrote: > > IIRC (from when I used it, 2+ years ago) there's also an add-in that > works the same way as the C# version does. I think it was this one: > http://vbxmldoc.tor-erik.net/ back when it was hosted on gotdotnet. > > > On 6/23/06, Bob Uva <[EMAIL PROTECTED]> wrote: > > > > Don't know. I just Googled (Google Groups) to find it. Have never > > used it. > > -------------- Original message ---------------------- > > From: Franklin Gray <[EMAIL PROTECTED] > > > > Does this tool insert the comments into the code as well or does > > > it > > just > > > create the xml file? > > > > > > > > > > > > > > > Message from Bob Uva <[EMAIL PROTECTED] > > > >@DISCUSS.DEVELOP.COMreceived on > > > 06/23/2006 01:00 PM > > > > > > 06/23/2006 01:00 PM > > > > > > > > > > > > Bob Uva < [EMAIL PROTECTED]>@DISCUSS.DEVELOP.COM > > > > > > Please respond to "Discussion of advanced .NET topics." > > > < [email protected]> > > > Sent by "Discussion of advanced .NET topics." > > > <[email protected]> > > > > > > > > > > > > To: [email protected] > > > cc: > > > Subject: Re: [ADVANCED-DOTNET] Documenting Dlls > > > > > > Check out the "XML Documentation Tool" listed on this page: > > > http://www.gotdotnet.com/team/vb/ > > > > > > -------------- Original message ---------------------- > > > From: Franklin Gray <[EMAIL PROTECTED]> > > > > "In Visual C# you can document the code you write using XML. C# > > > > is > > the > > > only > > > > programming language in Visual Studio .NET with this feature. > > > > For > > > details > > > > on creating an XML file with documentation comments, see the > > following > > > > topics." from help files. > > > > > > > > I forgot to add that I'm using VB.net 2003. Is XML Comments > > available > > > in > > > > VB.net 2003? Anybody have an example? > > > > > > > > > > > > > > > > > > > > Message from Eric Means <[EMAIL PROTECTED]>@ > > > > DISCUSS.DEVELOP.COM received on 06/23/2006 12:26 PM > > > > > > > > 06/23/2006 12:26 PM > > > > > > > > > > > > > > > > Eric Means < [EMAIL PROTECTED]>@DISCUSS.DEVELOP.COM > > > > > > > > Please respond to "Discussion of advanced .NET topics." > > > > < [email protected]> > > > > Sent by "Discussion of advanced .NET topics." > > > > <[email protected] > > > > > > > > > > > > > > > > > To: [email protected] > > > > cc: > > > > Subject: Re: [ADVANCED-DOTNET] Documenting Dlls > > > > > > > > Bob's solution is the best one. Not only is it pretty easy to > > generate > > > > help > > > > files, but if you distribute the .xml files with the .dll files, > > > > the > > XML > > > > comments show up in the Intellisense as well, which is great. > > > > > > > > On 6/23/06, Bob Uva <[EMAIL PROTECTED]> wrote: > > > > > > > > > > Use xml comments in your source and the open source tool ndoc > > > > > to auto-generate documentation. NAnt supports an NDoc task. If > > > > > you > > are > > > not > > > > > familiar with xml comments, check out the "Recommended Tags > > > > > for Documentation Comments" topic in VS.NET online help. > > > > > > > > > > Bob > > > > > -------------- Original message ---------------------- > > > > > From: Franklin Gray < [EMAIL PROTECTED]> > > > > > > I've been asked to document my common functions for other > > developers > > > > on > > > > > > other projects to use. My first thought was to do that > > > > > > using > > Word > > > but > > > > > > then thought it would be great if I could tie it into the > > > > > > help > > > system. > > > > > > > > > > > > 1) How you most document their dlls? > > > > > > > > > > > > 2) How hard is it to tie my methods and properties into the > > > > > > help > > > > system > > > > > so > > > > > > they can highlight it and press F1 and the help for the > > > > > > method > > or > > > > > property > > > > > > popps up? > > > > > > > > > > > > =================================== > > > > > > This list is hosted by DevelopMentor(r) > > > > > > http://www.develop.com > > > > > > > > > > > > View archives and manage your subscription(s) at > > > > > http://discuss.develop.com > > > > > > > > > > =================================== > > > > > This list is hosted by DevelopMentor(r) > > > > > http://www.develop.com > > > > > > > > > > View archives and manage your subscription(s) at > > > > > http://discuss.develop.com > > > > > > > > > > > > > > > > > > > > > -- > > > > Eric Means > > > > [EMAIL PROTECTED] > > > > http://www.randomtree.org/eric/ > > > > > > > > =================================== > > > > This list is hosted by DevelopMentor(r) http://www.develop.com > > > > > > > > View archives and manage your subscription(s) at > > http://discuss.develop.com > > > > > > > > > > > > > > > > =================================== > > > > This list is hosted by DevelopMentor(r) http://www.develop.com > > > > > > > > View archives and manage your subscription(s) at > > http://discuss.develop.com > > > > > > =================================== > > > This list is hosted by DevelopMentor(r) http://www.develop.com > > > > > > View archives and manage your subscription(s) at > > http://discuss.develop.com > > > > > > > > > > > > =================================== > > > This list is hosted by DevelopMentor(r) http://www.develop.com > > > > > > View archives and manage your subscription(s) at > > http://discuss.develop.com > > > > =================================== > > This list is hosted by DevelopMentor(r) http://www.develop.com > > > > View archives and manage your subscription(s) at > > http://discuss.develop.com > > > > > > -- > > Eric Means > [EMAIL PROTECTED] > http://www.randomtree.org/eric/ > -- Eric Means [EMAIL PROTECTED] http://www.randomtree.org/eric/ =================================== This list is hosted by DevelopMentorR http://www.develop.com View archives and manage your subscription(s) at http://discuss.develop.com =================================== This list is hosted by DevelopMentor. http://www.develop.com View archives and manage your subscription(s) at http://discuss.develop.com =================================== This list is hosted by DevelopMentor® http://www.develop.com View archives and manage your subscription(s) at http://discuss.develop.com
