JsDoc Toolkitを使う！
@property
最終更新：
aias-jsdoctoolkit
トップページ > ドックコメントの書き方 > タグリファレンス >
@property
JsDoc Toolkitでは、"プロパティ"と"メソッド"の扱いは若干異なります（ここでいう"メソッド"とは、ソースコード内で関数を参照しているメンバ変数のことです）。これは、通常メソッドの方がプロパティよりもAPIにとって重要であるという前提に基づいています。例えば -a オプションによって影響を受けるのはメソッドだけです。一方プロパティは、ドックコメントが書かれない限りドキュメントに出力されることはありません。
プロパティに対してドックコメントをプロパティの宣言ごとに個別に書くこともできますが、@propertyタグはより簡潔な方法を提供します - プロパティの記述をクラスの説明と同じ場所にまとめて書くのです。
構文
@property {propertyType} propertyName propertyDescription
- propertyType -- 省略可：プロパティのデータ型
- propertyName -- 必須：プロパティ名
- propertyDescription -- 省略可：プロパティの説明
- 備考：このタグの構文は@paramタグとほとんど同じです。
例
下の例では、仮に -a オプションが有効であっても id プロパティはドキュメントに含まれません。
function Person(id) {
this.id = id;
}
ドックコメントを付加すると、 id プロパティをドキュメントに含めることになります。
/**
*
@class
*/
function Person(id) {
/**
* The id of the person.
*
@type
number
*/
this.id = id;
}
@propertyタグは上と同じことを、もっとコンパクトな構文で実現します。
/**
*
@class
*
@property
{number} id The id of the person.
*/
function Person(id) {
this.id = id;
}
@propertyタグの使用は強制ではありませんが、このタグによってドックコメントをすっきりと見やすくすることができます。
/**
* @class
*/