Forums Register Login

JavaDoc package and class description

+Pie Number of slices to send: Send
Hello, I'm finishing up my assignment and want to ask about the javadoc for the package and class level.

How much description is needed for a package and class? Currently I use a one-liner describing the purpose of the package or class. Is it necessary to expand this by say including how this class is used in my application etc?

Thanks.
"I know this defies the law of gravity... but I never studied law." -B. Bunny Defiant tiny ad:
a bit of art, as a gift, the permaculture playing cards
https://gardener-gift.com


reply
reply
This thread has been viewed 825 times.
Similar Threads
NX: URLy Bird 1.3.1 JavaDocs
Javadoc for Package
Package Description
[ant] javadoc task
JavaDoc and package index
More...

All times above are in ranch (not your local) time.
The current ranch time is
Mar 18, 2024 23:14:39.