W3cubDocs

/JSDoc

@file

Table of Contents

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 
 */

© 2011–2017 the contributors to the JSDoc 3 documentation project
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
http://usejsdoc.org/tags-file.html