View Single Post
  #14   Spotlight this post!  
Unread 24-02-2016, 13:32
Unsung FIRST Hero
Karthik Karthik is offline
VEX Robotics GDC Chairman
no team
Team Role: Mentor
 
Join Date: Apr 2002
Rookie Year: 1998
Location: Toronto, Ontario, Canada
Posts: 2,340
Karthik has a reputation beyond reputeKarthik has a reputation beyond reputeKarthik has a reputation beyond reputeKarthik has a reputation beyond reputeKarthik has a reputation beyond reputeKarthik has a reputation beyond reputeKarthik has a reputation beyond reputeKarthik has a reputation beyond reputeKarthik has a reputation beyond reputeKarthik has a reputation beyond reputeKarthik has a reputation beyond repute
Re: Thoughts On Comments In Team Code

Quote:
Originally Posted by Alan Anderson View Post


I have seen code with too many comments. It was like
Code:
ACHK  EQU *       ; check if ASCII input is a letter
      LDA CNV     ; get the configuration value in the accumulator
      SUB #64     ; subtract 64
      BLT SKIP2   ; skip if less than zero
      ...
The first line's comment is helpful, describing what the routine is intended to do. The rest of the line-by-line commentary adds absolutely no information. It serves only to clutter the source code.
It added plenty of information for me. I would not have understood that snippet of code without the comments.
__________________
:: Karthik Kanagasabapathy ::
"Enthusiasm is one of the most powerful engines of success. When you do a thing, do it with all your might. Put your whole soul into it. Stamp it with your own personality. Be active, be energetic, be enthusiastic and faithful and you will accomplish your object. Nothing great was ever achieved without enthusiasm" -- R.W. Emerson
My TEDx Talk - The Subtle Secrets of Success
Full disclosure: I work for IFI and VEX Robotics, and am the Chairman of the VEX Robotics and VEX IQ Game Design Committees
.