I'm finally resuming work on my SCJD assignment (I purchased the assignment in 2002...better late than never).
I have two questions regarding the creation of JavaDoc for the assignment. The instructions read:
"Awkward or complex code should have descriptive comments, and javadoc style comments must be used for each element of the public interface of each class. You must create a full suite of documentation for the classes of the completed project. This must be generated using the tool "javadoc" and must be in HTML format. Provide javadoc documentation for all classes you write."
My questions are: a) Has anybody elected to generate JavaDoc comments for "protected" members as well? In the real world, I would be inclined to always document "protected" members since they are contractual (i.e. this is available to subclasses outside the package or the class itself). And if you did generate these comments - were points deducted for doing so?
b) Did you also create JavaDoc comments for the supplied suncertify.db.DB interface? The source code has been provided for this interface, but it does not include documentation comments. I would like to create JavaDoc comments for this interface (and maybe add some whitespace characters!), but I am concerned that the graders my automatically fail any assignment that introduces any changes to DB.java.
posted 9 years ago
I did provide JavaDoc for protected members and for the supplied suncertify.db.DB interface.