@class - JsDoc Toolkitを使う！

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

@class

@constructorタグと同じく、@classタグが付いた関数はコンストラクタとみなされます。ただしこのタグの目的はコンストラクタというよりも、クラスそのものを説明することにあります。

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

別名

@classdescription

構文

@class description

• description -- 省略可：クラスの説明

例

この例には２つの説明文が存在しています。1行目の文はタグ付けされておらず、コンストラクタ関数について説明しています。2行目の文は@classタグの一部であり、 Person クラス全体を説明するのに使用されます。
加えて@classタグの存在によって、この関数はコンストラクタであるとみなされます。

/**
   Creates a new Person.
   @class Represents a person.
 */

Person = function() {
}

関連項目

• @constructorタグ

---