• Describe the purpose and contents of each file in a block comment at beginning of file
• Put author contact information in the file block comment
• Include a version-control tag for source control repositories that support it, like CVS
• Include legal notices in the file block comment
• Give the file a name closely related to its contents

Here is an example:

/*-----------------------------------------------------------------------------
  Name:   SP_Filters.h
  Desc:     Simple Filter classes

  Copyright:
    copyright (C) 2008  shawndb@cs.unc.edu

    This software is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

  History:   
    Created by Shawn D. Brown (06/11/08)   
-----------------------------------------------------------------------------*/

-- ShawnDB - 16 Jun 2008
to top