A friendly place for programming greenhorns!
Big Moose Saloon
Register / Login
Win a copy of
video training course this week in the
Developer Certification (SCJD/OCMJD)
[URLyBird] Javadoc comments
Joined: May 18, 2006
Jun 12, 2006 15:36:00
My specification says:
"... javadoc style comments must be used for each element of the public interface of each class."
So I should have javadoc comments for public methods (and variables if any).
But should I write javadocs for protected methods and variables?
Jeroen T Wenting
Joined: Apr 21, 2006
Jun 12, 2006 23:51:00
I provide Javadoc comments for everything except some datamembers (mostly private ones).
The generated Javadoc I limit to public only to save a bit of space.
It is sorta covered in the
JavaRanch Style Guide
subject: [URLyBird] Javadoc comments
Disallowed to use private inner classes?
B&S: What types do you comment with javadoc?
A old question: shall we write comment for the private methods and variables?
Javadoc - only public members?
All times are in JavaRanch time: GMT-6 in summer, GMT-7 in winter
| Powered by
Copyright © 1998-2015