Details of difference between @see and @inheritDoc

First of all, you should remove the original eclipse template because it is just noisy junk. Either put meaningful docs in or don’t put anything at all. But useless restating of the obvious using IDE templates just clutters the code.

Second, if you are required to produce javadoc, then you have to make the comment start with /**. Otherwise, it’s not javadoc.

Lastly, if you are overriding then you should use @inheritDoc (assuming you want to add to the original docs, as @seh noted in a comment, if you just want to duplicate the original docs, then you don’t need anything). @see should only really be used to reference other related methods.

Leave a Comment