|
|
|
|
|
by teknopaul
1591 days ago
|
|
Word. I call them SBO comments (stating the bleeding obvious) and prune them from code. Pretty much all doc gen tools can generate is SBO comments so they are rarely useful. Often they are essentially wrong, e.g. a getter with the autogenerated comment "gets the X from Y" without checking the method code to see if actually, it has some horrible side effects that you would not expect to be there.
The comment hides the truth about the method. |
|