Correctness is the official language of comments

Is there something that prevents us from writing complete sentences in inline comments?  I just got through spending nearly an hour trying to figure out why some code was setting up DMA transfers in a distributed system only to get to the bottom of things and find a comment that looks like someone took a comb through the paragraph and knocked out ever other word.  Seriously.  Someone thought it was okay to describe a subtle bug with a complex workaround by saying things like “if thread 0, xfer for 8, in case not and see 4 where xfers aren’t there”.

Would it really have taken much longer to write in complete sentences?

Leave a Reply

Your email address will not be published. Required fields are marked *

*

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>