Preserved Topic: Feel the Javadoc (Page 1 of 1)

I just feel in love with javadoc (a utility included with JDK [java developement kit]).

I used to open up notepad and scroll out a couple of lines about what each method does, how it should be implemented. With this great new discovery, my comments in the code, are magically turned into this really cool HTML page(s) that display all the information about the class.

/**

*Initialize the vector to a given lenght

*@param length

*the length of the vector

*<dt><b>Precondition:</b><dd>

*i<=0 or i> the vector's length

*<dt><b>Postcondition:</b><dd>

*returns the <i>i</i>th value

*@exception IllegalArguementException

*Indicates the value to be returned is not in the range.

*<dt><b>Big-O:</b><dd>

*O(1)

**/

Some commenting as easy as shown above leads to the generation of this really snazzy looking HTML page, with all the information presented about your class in a easy to understand fashion. I can just give this HTML file to the people I am working with, and they will know how to implement all my methods, know what the input needed is, what the output they will recieve is, as well as the Big-O run time of the application.

All this in your program's comments!

It is just too much to believe possible!

elated,
-mage

Yes! I know Javadoc, and it's frigging *awesome!*! We've developed our latest packahge in JRUN and noticed this early on. Now, we have a multi-part development environment with a pre-processor and a series of applications to handle the publishing process, something like 30,000 lines of code last I looked, a potential nightmare for anyone working down the line, you'd think, eh? Heh, I'm waiting for someone to ask, "Nice application, but have you any... documentation?" Yes! Multi-pgaed, framed version of *all* packages and classes, with detailed notes on each! Would you like to see that as a tree, or a hierarchical listing? We got SO MUCH documentation, it's coming out our ears!

(I just saw the first "From Dusk till Dawn" last week on cable, does anybody remember Cheech Marin's performance as the doorkeeper, and his sales pitch for the wonders waiting inside the "Titty Twister"? I could go on like that about documentation.)

I like Java. We did a dump of the application and ported it from Sun to W2K, just for the heck of it, and it worked flawlessly, first time! Cool beans.

Your pal, -doc-

YEAHHHHH JAVA RULES!
I'm actually specialising myself(so hey, ok, i'm an insect!!) in java, studying the inner working of the java virutal machine, exploring existing api's... and yeahhhh, that rocks.
Javadocs kills!
It demands a little effort when you code, but it's really worth the effort.
SUN DO made a great thing.

I just hope that langage will have a long life!

HURRA FOR JAVA!