Comments are evil?

In the 1980 comments were used to reduce the “gap” between unstructured code and “rationale” behind the code.

  1. C/64 Peek and poke where oscure.
  2. Gosub on function pointed by numbers was bad
  3. 8-bit systems was tight on command names and so on (think to write a python interpreter in Arduino/bbc:Micro, or look at the memory consumed by the COMMAND STRINGS on C/64 Basic v2)
  4. C code was not expressive, but good code required little comment, as you can see here

Today comments are used to:

  1. Comment obscure code -> instead of writing it better
  2. Comment caching code you will end up to commit breaking production ->instead of having a cache config to disable cache on dev machines
  3. Comment not working code will end up in production, producing functional breaks -> becase you will forget it and  commit the bad version

When I am sent on a Red Project, the code is often obscure and not commented at all. So I dare to suggest to deprecate comments at all, replacing it with a set of meta annotation like:

 

 

 

 

Leave a Comment

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

This site uses Akismet to reduce spam. Learn how your comment data is processed.