1
私はJSモジュールにJSDocの:HTMLページにJSDocのによって生成されるように、参照のtypedef-EDタイプの他のモジュールから
// somewhere/foo.js
/**
* @module
*/
/**
* @typedef Foo
* @type {object}
* property {string} bar - some property
*/
をtypedefのタイプを持っていると仮定するとは、別のモジュールでは、このタイプを参照することが可能です型は型定義されたモジュールへのリンクとして表示されますか?
完全に...これは私の作品
// somewhere_else/bar.js
/**
* @module
*/
/**
* @param {somewhere/foo/Foo} foo - some param
*/
export default function doStuff(foo) {
...
}
を私はこれのバリエーションを試してみましたが、何も動いていないようにみえ@typedefのモジュールを修飾することはできます(私はpersonnalyが '@typedef {Object}モジュール:foo/Foo'を書いていましたが、これは好みの問題です。)しかし、1 /' /// 'は必要ではないようだが、どこにも書かれていない。 2 /モジュールが長いパス( 'somewhere/foo'のような)を持っていればどこにでも入力するのはちょっと面倒ですが、何とかそれをエイリアスするトリックを知っていますか? –
phtrivier
@phtrivier 1.申し訳ありませんが、参照はコピーと私のテストから貼り付け、それを無視しています。あなたと少しは面倒です。残念ながら、 "エイリアス"は私たちが(特にプロトタイプを使って)文書化する方法です。実際、見た目はそれほど悪くはありません。このメソッドや型を使用する開発者は、定義されている場所を正確に知ることができるので、正しいドキュメントを作成するだけでなく、効率的な参照を探す開発中に役立ちます。 "@exports"を使うもう一つの方法ですが、私はこのオプションを発見しなかったので、コメントできません。 –