Email: Password: Remember Me | Create Account (Free)

Back to Subject List

Old thread has been locked -- no new posts accepted in this thread
???
03/01/05 00:26
Read: times


 
#88728 - More comments
Responding to: ???'s previous message

Lines like:

clr C ;clear carry

or
mov a,1 ;load A with 1

are really just a waste of space - they tell us nothing. I suggest you read 'Code Complete' on the art of comments. The comments are there to describe what the code is doing at a higher level - if the person reading the code doesn't understand that clr c actually clears the carry bit, then he's not going to get to far with the code. Obviously comments that describe the algorithm used and the way the parameters are passed are going to be are far more use to the person reading the code rather than a comment per line that tells us nothing. "Quality vs Quantity"!

Hey, I used to do the same thing until the uselessness was pointed out to me. Especially now, since my code is maintained by others as well as being reviewed, the issue of commenting makes a big difference to understanding the code.


List of 6 messages in thread
TopicAuthorDate
request for comments on keyboard encoder            01/01/70 00:00      
   Comment on Comments            01/01/70 00:00      
      right...            01/01/70 00:00      
      Comment on Comments on Comments            01/01/70 00:00      
   More comments            01/01/70 00:00      
      gotcha.            01/01/70 00:00      

Back to Subject List