On 2007-09-06 11:53, Dirk Meyer wrote: > Right. Doc inside the source is also very helpfull. Besides that, I > wrote down some coding style rules. Not every rule is as important as > the other one and not every dev uses these rules, but it is a good > guideline:
I know we've argued about some of these rules. :) At the very least, 4 needs to be changed from 80 to 120, since we both agreed on this one. Also, 3 maybe needs to be reworded. I obviously don't disagree about adding more code documentation, but you said to add comments to the effect of "add xy to z" which, when interpreted the way I do, I rather think is not only pointless but a bit embarrassing. I'm reminded of some code submitted by a web hosting company that I reviewed at a previous job. One of my initial requirements for the project is that the code had to be well documented. As a result, the code was riddled with meaninglessness like this: # increment x by one $x += 1; As for 10, I prefer in writing we're a bit more rigid. Prefer "(x, y)" over "( x, y )" and "(x,y)". Actually a better rule is just to adapt to the coding style of the file you're editing. Might also be worth mentioning the convention of prefixing private methods and variables with underscores. Although that's something that even our own code is not so consistent with. :) ------------------------------------------------------------------------- This SF.net email is sponsored by: Splunk Inc. Still grepping through log files to find problems? Stop. Now Search log events and configuration files using AJAX and a browser. Download your FREE copy of Splunk now >> http://get.splunk.com/ _______________________________________________ Freevo-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/freevo-devel
