Writing a documentation for Java-Language

Question

Im learning Java with the tutorials here at sun.
Because my english is not best, I write down all "important" things in an own Dokumentation in german language.
Because there may be some code I write there, it would be useful to write the Documentation as *.java , because these code snipets are better to read then.
My question: Is there a possibility to write my documentation as *.html file , and the code snippets are same like I would write them in my JCreator-program (I mean, that keywords as int or class are written in blue, for example...) ?
Thanks in forward
Martin

Answer 1

You can use JavaDoc on your own code. To do this you would add comments in your code using the Javadoc comment style:
* This is JavaDoc
* Continue your comments here
* @author this is the author
* @param describe a paramater here
* @param describe another paramater here
* @return this line describes the return value
Then run the JavaDoc program on your code and it will produce the same kind of html that you see with the Java API html documentation. For more info check out the book Thinking In Java (available for free at www.bruceeckel.com )