debug define comments

In he lab, working the core issue, I just use printf extensively, even in testing components. Code is spaghetti, in the lab the correct model is none, if you had a coding model you wouldn't be in the lab, by definition, IMO.  Then you want the thing available for production use.  Your printfs become DebugPrint, a macro you can turn off and on. When turned on, they print certain key variables, not just any old random variable.

The the comments need to be formalize, or even added in  my case.  I rarely use comments in the lab. But then the real thing comes, other developers need the instruction to avoid the reverse engineer problem. So you formalize the comments a bit,a regular one lines, of ten lines devoted to a section or module.  And, mark your comments with something, preferably the industry standard comment marker that allows for extraction onto a web manual.

Easy, fun work; more fun then staring at some three level structure pointer collision in the debugger. Way more fun than debugging.