The Mudcat Café TM
Thread #28443   Message #352936
Posted By: GUEST,Fibula Mattock
07-Dec-00 - 05:22 AM
Thread Name: BS: Is this comprehensible?
Subject: RE: BS: Is this comprehensible?
Comments are so helpful when you're picking up and developing someone else's work, and I had to spend most of last summer deciphering uncommented code so I'm all in favour of them. I agree that the above example is small enough to be understood, but the good programming practice seems to be to always include at least one line at the start to explain what your program does, and then a line or two for each function (stating explanation, arguments, etc.). I suppose it all boils down to this hypothetical "good programming practice". We got marks taken off in university for not using correct indention. Then I got a programming job and saw that most of the code was just hacked fixes and indention barely entered into it. Still... in an ideal world...