Javadoc for VB .NET ?
Javadoc for VB .NET ?
Javadoc for VB .NET ?
Javadoc for VB .NET ?
Javadoc for VB .NET ?
Javadoc for VB .NET ? Javadoc for VB .NET ? Javadoc for VB .NET ? Javadoc for VB .NET ? Javadoc for VB .NET ? Javadoc for VB .NET ? Javadoc for VB .NET ? Javadoc for VB .NET ?
Javadoc for VB .NET ? Javadoc for VB .NET ?
Javadoc for VB .NET ?
Go Back  Xtreme Visual Basic Talk > > > Javadoc for VB .NET ?


Reply
 
Thread Tools Display Modes
  #1  
Old 05-16-2005, 08:34 AM
Anakin Anakin is offline
Centurion
 
Join Date: Nov 2003
Posts: 127
Default Javadoc for VB .NET ?


Does VB .Net have a tool similar to Java's javadoc?

I was researching if it was possible to create documentation in this fashion but can't find any information.

Thanks.
Reply With Quote
  #2  
Old 07-23-2009, 12:43 AM
Rapiant's Avatar
Rapiant Rapiant is offline
Centurion
 
Join Date: Jun 2008
Location: Iowa
Posts: 111
Default

the closest thing is using three apostrophes and have the documentation auto set
__________________
--Adam Lee--

Website
My Blog
Reply With Quote
  #3  
Old 07-23-2009, 01:38 AM
Qua's Avatar
QuaJavadoc for VB .NET ? Qua is offline
Impetuous & volatile

* Expert *
 
Join Date: Apr 2005
Posts: 2,177
Default

There are plenty of documentation generators available, the most popular one I believe is NDoc. I've never personally used the tool, but I'm under the impression that it'll work for C# as well as VB.NET, but you can properly find out more in the user guide.

If it does not suit your need, google does have a whole list of documentation generators.
__________________
Reading is the foundation for all knowledge - Unknown.
Reply With Quote
  #4  
Old 07-24-2009, 10:39 AM
AtmaWeapon's Avatar
AtmaWeaponJavadoc for VB .NET ? AtmaWeapon is offline
Fabulous Florist

Forum Leader
* Guru *
 
Join Date: Feb 2004
Location: Austin, TX
Posts: 9,500
Default

There's not a whole lot of love for document generation in the .NET world.

Doxygen is a multi-language, GPL documentation generator, but I didn't see VB .NET in its list of supported languages. A little searching makes it look like there's a way to get it to work, but I've never tried.

(Skip this paragraph if you want facts but not a funny story.)
I wouldn't use NDoc. See how the last news update was in 2005? Here's the story (it's one of my favorites for some reason!) NDoc was written in the .NET 1.1 timeframe, and it was awesome because it was the only way to generate MSDN-style documentation for .NET source code. When VS 2005 released, there were a few language features that NDoc choked on. The major thing it couldn't do was generics; List(Of T) would get documented as List`1. The developer was working on it, but suddenly had a meltdown. He complained that he was the only person working on it and didn't have enough time to do work that paid the bills and work on NDoc. He further complained that, in all the time NDoc was developed, he'd only had a few donations. He proclaimed that since people didn't want to fund his development of NDoc he quit. That was the last day there was any activity on the project. This was, simply put, the stupidest rant I've ever seen. Open-source projects by definition should have more than one developer. There were over a dozen people who had tried to submit features, but all were rejected. This guy wanted to be the ONLY developer on the project, but then complained that he didn't have enough time? Furthermore, it was a FREE, OPEN-SOURCE project (though the "free" and "open" aspect is in question since I see no license information.) No one was obligated to donate. You don't make money off of a project like this by asking people to pay for it, you make money by putting "I'm the dude who wrote NDoc, which I know you use" on your resume!

Anyway. As of the last time I used NDoc it didn't support generics. I know that someone, somewhere has added the support because I just might know a product that uses it. The last source commit was a year ago, so I'm not sure what kind of development is still ongoing.

The alternative is Microsoft Sandcastle. It was announced really soon after the NDoc meltdown. It's supposedly the tool MS uses to generate MSDN documentation, and I must admit it makes some pretty files. The last I used it, there wasn't a GUI for it, but this was years ago and I hear there's some neat ones now. I'd recommend this, since MS is making it. It's a shame it took them 3 versions of .NET to release a doc tool.

Both NDoc and Sandcastle use XML documentation comments, which for some reason are considered a C# feature even though the VB IDE supports it. To document a member, you use triple-comment syntax:
Code:
''' <summary>
''' Does something really amazing
''' </summary>
Public Class AmazingCode
End Class
All in all, I wish I could just say "use this" on a particular tool, but MS is really not treating documentation generation as an important thing. I blame this on my observations that MS cares primarily about application developers, demoting library developers to 2nd-class citizens. This is foolish, because good app developers have to write libraries too!
__________________
.NET Resources
My FAQ threads | Tutor's Corner | Code Library
I would bet money 2/3 of .NET questions are already answered in one of these three places.
Reply With Quote
Reply


Currently Active Users Viewing This Thread: 1 (0 members and 1 guests)
 
Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is Off
HTML code is Off

Forum Jump

Advertisement:





Free Publications
The ASP.NET 2.0 Anthology
101 Essential Tips, Tricks & Hacks - Free 156 Page Preview. Learn the most practical features and best approaches for ASP.NET.
subscribe
Programmers Heaven C# School Book -Free 338 Page eBook
The Programmers Heaven C# School book covers the .NET framework and the C# language.
subscribe
Build Your Own ASP.NET 3.5 Web Site Using C# & VB, 3rd Edition - Free 219 Page Preview!
This comprehensive step-by-step guide will help get your database-driven ASP.NET web site up and running in no time..
subscribe
Javadoc for VB .NET ?
Javadoc for VB .NET ?
Javadoc for VB .NET ? Javadoc for VB .NET ?
Javadoc for VB .NET ?
Javadoc for VB .NET ?
Javadoc for VB .NET ? Javadoc for VB .NET ? Javadoc for VB .NET ? Javadoc for VB .NET ? Javadoc for VB .NET ? Javadoc for VB .NET ? Javadoc for VB .NET ?
Javadoc for VB .NET ?
Javadoc for VB .NET ?
 
Javadoc for VB .NET ?
Javadoc for VB .NET ?
 
-->