Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Does "/* (non-javadoc)" have a well-understood meaning?

Does /* (non-javadoc) have a meaning, beyond pointing out to the reader of source code that a comment block is intentionally not a Javadoc comment? Lately I've seen a lot of code that looks like this:

/*
 * (non-javadoc)
 *
 * This method converts widgets to gizmos
 */
public Foo bar() {
   ...

Is this an established convention of some kind? If so, what does it mean (beyond the obvious literal meaning) and when is it used?

like image 614
Pops Avatar asked Jan 04 '11 19:01

Pops


2 Answers

According to the info I could find, this was to fix a bug in older versions of the JavaDoc tool (or more likely older version of Eclipse's processing of JavaDoc comments) that would not display the correct documentation for a method that overrides the method of a parent class.

As noted by Konstantin, Eclipse's override template includes this text.

like image 139
Powerlord Avatar answered Oct 24 '22 08:10

Powerlord


It doesn't have an established meaning besides being a comment. The formatting is result of common Eclipse code formatting templates, which explains its commonality.

like image 28
Konstantin Komissarchik Avatar answered Oct 24 '22 10:10

Konstantin Komissarchik