JsDoc Toolkitを使う!

@augments

最終更新:

aias-jsdoctoolkit

- view
管理者のみ編集可

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

@augments

@augmentsタグは、ドキュメント化されたクラスが別のクラスを継承しており、そのクラスのメソッドやプロパティを使用できることを示します。

別名

@base, @extends

構文

@augments otherClass

  • otherClass -- 必須:このクラスの継承元クラスのネームパス

/**
 * @constructor
 */

function GeneralWriter() {
}

/**
 * @constructor
 * @augments GeneralWriter
 */

function SpecialWriter() {
}

作成されたドキュメントの SpecialWriter の項では、 GeneralWriter の全てのメソッド・プロパティが SpecialWriter へ継承されたものとして表示されます。

関連項目


ウィキ募集バナー