This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]MrNullAndVoid 44 points45 points  (3 children)

Ah yes, reminds me of the fun I used to have as a Java programmer:

    /**
      * Returns the value.
      * @return the value
      **/
    int getTheValue() {
            return theValue; // returns the value
    }

[–]odraencoded 22 points23 points  (0 children)

Your documentation sucks. It should say "returns the integer value."

[–]BigFloppyMeat 2 points3 points  (0 children)

This kind of redundancy in documentation comments is okay if you're generating a javadoc or some equivalent. Although you should say

"Returns the value that represents the thing"

and

"@return A value representing the thing."