Skip to main content

@file

Syntax​

@file description

Overview​

@file marks a JSDoc block as a file-level description. Place it at the very top of a file, in the first JSDoc comment, to describe the file's purpose. It can be combined with @author, @license, and @copyright.

Example​

/**
 * @file Authentication utilities for the web application.
 * @author Alice Johnson <alice@example.com>
 * @license MIT
 */

'use strict';

// ... module code ...

See also​

Official reference: jsdoc.app/tags-file