7.5 Top/file-level comments

A file may have a top-level file overview. A copyright notice , author information, anddefault visibility level are optional. File overviews are generally recommended whenever afile consists of more than a single class definition. The top level comment isdesigned to orient readers unfamiliar with the code to what is in this file. Ifpresent, it may provide a description of the file's contents and anydependencies or compatibility information. Wrapped lines are not indented.

Example:

  1. /**
  2.  * @fileoverview Description of file, its uses and information
  3.  * about its dependencies.
  4.  * @package
  5.  */