パラメータとして渡されたコンストラクタ(関数)をドキュメント化するにはどうすればよいですか?JSDoc 3ドキュメントコンストラクタ/クラスパラメータ
例:
/** @class */
function A() {}
/**
* @param {Function} aConstructor
*/
function createA(aClass) {
return new aClass();
}
あなたが見ることができるように、私はそれが関数であることを指定することができます。しかし、その関数がどのオブジェクトを作成するかを指定することはできません。これを文書化する方法はありますか?
ありがとうございました。
なぜ '@ returns'のように' @returns {A} 'や複数の型が可能な場合は' @returns {A | B}} 'を使うことができますか? –
'@constructs'(これは、http://usejsdoc.org/tags-constructs.htmlの2番目の例を参照してください) –
でこれを行うことができるようです。まさにそのデータ型を返すでしょう。ただし、パラメータ自体の予期されるデータ型であることを厳密に示すものではありません。他の例と同じです。 – samanime