CompuServe Messages

Software Design

    01-Sep-93 07:48:28
Sb: #36588-Software Design
Fm: Greg Comeau@Comeau Cmptg 72331,3421
To: dan barber 72010,2527
>1) Name all software components (.c, .h, functions, variables, etc) > using a given standard. Yes, things like this can often be good. Lots can be said for consistency. >2) Provide detailed prologues for every function (Roughly, a page or > more in length) The length is not an issue for me, the explanation is though. I want to know stuff like the expected input, expected output, at least general algorithm taking place. That the _minimum_ comments I want to see. >3) Deleting debug statements from software before building to controlled > library I'll disagree with this for a number of reasons. Some are simply practical. Others, in the spirit of some of this thread is that some debug statements can actually take the form of enhancing the clarity of the code. OTOH, perhaps we are not speaking of the same types of debug statements. >4) Style guides for code development: e.g. placement of braces Yes, though this is a hard one as there are many forms of things like this.