My goal is add javadoc tags so that my java code can be generated and will save time. Does the code below do that? What is the @param and @throws actually do when it is run by the java doc? Are the javadoc tags below a good example to look at?
Javadoc is a tool for documenting your code. It doesn't generate code itself.
You use the Javadoc annotations in your Java files to associate comments with your classes and methods.
You use the Javadoc tool to generate the actual java documentation, which will be in the format that you see in the Java API.
Some IDEs will help you generate your javadoc comments based off your code. For example, in Eclipse, if you type "/**" and hit return above a method, it'll generate the @params, @throws, and @return statements for you. You'll still need to add the actual content (description of method, any additional details on the params, what the return value means). [ May 19, 2008: Message edited by: Stevi Deter ]
There will always be people who are ahead of the curve, and people who are behind the curve. But knowledge moves the curve. --Bill James
You showed up just in time for the waffles! And this tiny ad:
Building a Better World in your Backyard by Paul Wheaton and Shawn Klassen-Koop