Skip to main content

@file

Synonyms​

  • @fileoverview
  • @overview

Overview​

The @file tag provides a description for a file. Use the tag in a JSDoc comment at the beginning of the file.

Example​

File description

/**
 * @file Manages the configuration settings for the widget.
 * @author Rowina Sanela
 */