including sample code
Hi all,
I might sound to be really dumb, however, I'm new to java documentation and am trying to figure out a way to include sample code (with indentation and everything) in the documentation to the class.
Can someone tell me how? I would really appreciate any input.
thanks
[314 byte] By [
ksakhamuri] at [2007-9-26 16:42:08]
Use the "CODE" tag to make it be in the courier font and the "PRE" tag to make it keep the indentation. You can then just include the excerpt in the javadoc comment.
One note : you might want to consider something else if this is to show how the method works, posting code in the javadoc is best used to show samples of how to use the method. You didn't say what code you were including.
smhr at 2007-7-2 20:32:23 >
