Tres what Johannes is saying is documenting the code in the form of inline code comments as to what blocks of code do.
On Wednesday 29 January 2014 09:44:22 Tres Finocchiaro wrote: > > I can, but I guess this might need to be discussed, and moreover, it is > > not a task that you can finish for the next (or any) release. Are you > > sure? > > Agreed. Documenting code is a standard, a practice or perhaps a culture > but isn't a task. > > A task may be to establish better coding guidelines, but from my experience > it's much more effective to just police the commits and address the > offenders, which would probably best be done by Toby. > > Tough to criticize free help, but if it's important to the project, the one > accepting the commits should police this a bit and reject items that lack > the basic "this is what this does" comments. (overkilling comments can be > worse than no comments, but most developers know this already). > > -Tres ------------------------------------------------------------------------------ WatchGuard Dimension instantly turns raw network data into actionable security intelligence. It gives you real-time visual feedback on key security issues and trends. Skip the complicated setup - simply import a virtual appliance and go from zero to informed in seconds. http://pubads.g.doubleclick.net/gampad/clk?id=123612991&iu=/4140/ostg.clktrk _______________________________________________ LMMS-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/lmms-devel
