@fileOverview - JsDoc Toolkitを使う！

トップページ > ドックコメントの書き方 > タグリファレンス >

@fileOverview

@fileOverviewタグには、ファイル全体についての説明を記述することができます。

• http://code.google.com/p/jsdoc-toolkit/wiki/TagFileOverview

別名

@overview, @projectdescription

構文

@fileOverview fileDescription

otherTags

• fileDescription -- 必須：ファイルの説明
• otherTags -- 現在@fileOverviewと共に使用できるタグとして以下がサポートされています。：@author、@version
• 注意：@fileOverviewを含むドックコメントは、１ファイルの中で１つだけにするべきです。

例

/**
 * @fileOverview This file has functions related to documenting JavaScript.
 * @author <a href="mailto:[e-mail]">Michael Mathews</a>
 * @version 1.0.1
 */

---