dict.org

The DICT Development Group


Search for:
Search type:
Database:

Database copyright information
Server information


1 definition found
 for comment
From The Free On-line Dictionary of Computing (30 December 2018) :

  comment
  
      (Or "remark") Explanatory text embedded in
     program source (or less often data) intended to help human
     readers understand it.
  
     Code completely without comments is often hard to read, but
     code with too many comments is also bad, especially if the
     comments are not kept up-to-date with changes to the code.
     Too much commenting may mean that the code is
     over-complicated.  A good rule is to comment everything that
     needs it but write code that doesn't need much of it.
     Comments that explain __why__ something is done and how the code
     relates to its environment are useful.
  
     A particularly irksome form of over-commenting explains
     exactly what each statement does, even when it is obvious to
     any reasonably competant programmer, e.g.
  
     	/* Open the input file */
     	infd = open(input_file, O_RDONLY);
  
     (2007-02-19)
  

Contact=webmaster@dict.org Specification=RFC 2229