This week's book giveaways are in the Refactoring and Agile forums. We're giving away four copies each of Re-engineering Legacy Software and Docker in Action and have the authors on-line! See this thread and this one for details.
javadoc comments for interfaces AND implementing classes?
posted 13 years ago
Quoted from instructions.html: "...and javadoc style comments must be used for each element of the public interface of each class." In case there is a class that implements an interface, and we only write javadoc comments in the interface - but not the class - then the description of the methods in the interface are copied from the interface documentation to the class' documentation. Is it ok to write javadoc comments only for the interface methods, or do we have to write javadoc comments for the class' methods as well?
Hi Leonardo, That depends on the implementing class. If there is something unusual or different, then you should probably javadoc it again in the implementation, otherwise just let the interface's javadoc be used. Hope this helps, Michael Morris
Any intelligent fool can make things bigger, more complex, and more violent. It takes a touch of genius - and a lot of courage - to move in the opposite direction. - Ernst F. Schumacher