@file

描述: 描述一个文件。

别名:

  • @fileoverview
  • @overview

Overview(概述)

@file标签提供文件的说明。在文件开头的JSDoc注释部分使用该标签。

Example (例子)

例如,文件描述:

/**
 * @file Manages the configuration settings for the widget.
 * @author Rowina Sanela <rsanela@example.com>
 */