Quote:
Originally Posted by davidthefat
Code:
<snipped for brevity>
Now honestly how in the world can I comment better than that? (Serious) That is really this year's code.
|
I haven't seen much of the Java code, just C++ however I'd like to point out - quality over quantity.
Those latter few comments seem rather un-descriptive to me but I don't mind I don't think the original poster thought doc comments were the issue.
EDIT: On the note of quite a few of WPILib's function comments, I find them lacking in actually useful documentation. A lot of them generally take the name of the function, and expand it to a grammatically correct English sentence instead of saying something useful like for instance, the unit of the return value (off the top of my head).