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?
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.
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.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With