View Single Post
  #7   Spotlight this post!  
Unread 01-25-2011, 11:56 PM
basicxman basicxman is offline
Emily Horsman
FRC #2200 (MMRambotics)
Team Role: Programmer
 
Join Date: Oct 2007
Rookie Year: 2007
Location: Burlington, Ontario
Posts: 971
basicxman has a brilliant futurebasicxman has a brilliant futurebasicxman has a brilliant futurebasicxman has a brilliant futurebasicxman has a brilliant futurebasicxman has a brilliant futurebasicxman has a brilliant futurebasicxman has a brilliant futurebasicxman has a brilliant futurebasicxman has a brilliant futurebasicxman has a brilliant future
Send a message via AIM to basicxman Send a message via MSN to basicxman Send a message via Yahoo to basicxman
Re: Bad Programming Practices

Quote:
Originally Posted by davidthefat View Post
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).
Reply With Quote