More on javadoc (was: Re: [Aldor-l] +++ Documentation structure)

Christian Aistleitner tmgisi at gmx.at
Thu Apr 28 06:25:23 EDT 2005


Hello,


> The goal should be to write a nice documentation tool comparable to
> JavaDoc.

since probably not everybody knows javadoc:
javadoc is a documentation extraction tool for java.
It comes with Sun's java develpoment kit.

I will just give ome Links for those who are interested

The tool's homepage:
http://java.sun.com/j2se/javadoc/

Style guide for documentation comments in java:
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

Some java file from the web (with documentation comments):
http://www.cs.wm.edu/~debbie/cs141/jdRat/Rational.java

The documentation generated by javadoc:
http://www.cs.wm.edu/~debbie/cs141/jdRat/Rational.html

--
Best regards,
Christian



More information about the Aldor-l mailing list