Doug Cutting wrote:
[EMAIL PROTECTED] wrote:
+ /*
+ * (non-Javadoc)
+ * + * @see
org.apache.nutch.io.Writable#write(java.io.DataOutput)
+ */
+ public final void write(DataOutput out) throws IOException {
We should either include javadoc or not. In general, all public methods
should have javadoc. In this case, since this is implementing an
interface method, if no Javadoc comment is added, then the interface's
will be used. That would be preferable. Frequently in this case folks
add a comment like:
// javadoc inherited
Doug
Doug,
It is not a JavaDoc comment as it does not start with "/**" - it has
exactly the efect you mentioned - the JavaDoc would be inherited - in
fact Eclipse generates such comment automatically. In fact in my opinion
both versions (//javadoc inherited) and commited one are ok and I have
no preferences towards any of them.
Regards,
Piotr
