search

frc1675 / frc1675-2014

Code for FRC 1675's 2014 robot, Professor X
Other
0 stars 0 forks source link

Prune old commented out code #1

Open pordonj opened 10 years ago

pordonj commented 10 years ago

We should clean the code of a vast majority of commented-out code. Except for key debugging printouts that can be left in and commented and few other spots, commented-out code just clutters the project and can be recalled from previous revisions.

pordonj commented 10 years ago

Tony worked in this earlier this week. Will review this weekend.

pordonj commented 10 years ago

Went through and edited a ton of comments. Took out stuff that was like "This doesn't work" or "Would be nice if we had encoders". The ones that don't work are noted as bugs.

"@author" is really weird and I almost feel like we should take them all out. But it is nice for when 1 person is the one who wrote most of it.

pordonj commented 10 years ago

I think this is pretty much done but would like @windndust to look over everything before we resolve.

Tstano commented 10 years ago

I'd be cool with removing the @author stuff. It was mostly automatically generated so I just assumed that was a thing you're supposed to do.
I would suggest leaving the comment at the top that explains what each class does though.

windndust commented 10 years ago

Agree with removing the @author tag. It's only really useful in determining who initially created the class but we have git to tell us that.

I like the package organization much better