View Single Post
Old May 30, 2011, 06:14   #1
Derakon's Avatar
Join Date: Dec 2009
Posts: 9,023
Derakon is on a distinguished road
A plea for comments

I decided to take a stab at allowing ego items to have negative pvals, which requires understanding how the file parser works. This is...not helped by the fact that there are basically no comments for any of the code.

I know that the 2.8.3 days had very verbosely commented code; practically every line had a comment. That's not really necessary IMO, but on the flipside, every function more complicated than a getter or setter needs to have a comment. Please, when you modify a function, if you know what it does, comment it! If that function has a complex block within it, comment that too. You'll make everyones' lives easier. Commenting's not really fun, I know, but it'd be a big help in convincing people to contribute.
Derakon is offline   Reply With Quote