Documentation Standards

External Documentation

The following should be included as a long comment at the beginning of your
program: 

     Full Name
     ID #
     General description of what the program does. 
     Give limitations (positive or negative), bugs, special features, and
       assumptions made, if any.


Internal Documentation

     Comments next to a declaration of a variable or data member should
     provide extra information not conveyed by the identifier's name. The name
     of a variable should tell as much about it as is possible without making
     it too long; additional information can be supplied by a comment.