@file (synonyms: @fileoverview, @overview)¶

.. @file::¶

概述

@file标记提供文件的描述. 在文件开头的JSDoc注释中使用标记.

同义词

@fileoverview, @overview

示例

File description¶

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

.. @overview::¶

.. @fileoverview::¶