Going through the code and for the most part removing all the change comments (with a date), I've had a change in philosophy one how code should be commented. Perhaps for a released program, it makes sense to add a comment with a date when a bug is fixed, but during development and debugging it's expected that there will be a lot of changes. Making a dated change comment for every single change is just a bit excessive - and this certainly could be seen here.
The comments at the beginning of the files probably should be removed also or at least cleaned up, but these were left alone for the time being. Perhaps some of the major highlights will be left in. In any case, going forward, the git commit comments will be relied on to comment the changes made to the source file. Functionality comments will still be added as needed, but without all the change comments, the code should be easier to read.
The latest commit contains more of this comment clean up. All of the project is now using Qt functions; all the standard C library functions (and associated include statements) have been removed. Most if not all the variables and functions have been renamed to the new naming scheme. This is probably a good place to add another tag, and so the current code was tagged as v0.2-3.
[commit ebe943379d]
Wednesday, November 7, 2012
Subscribe to:
Posts (Atom)