5

JSDoc3 が他のモジュールからクラスへのリンクを自動的に生成する方法を見つけようとしています。言葉で説明するのは難しいと思うので、いくつか例を挙げてみましょう。次のスクリプトは、期待される出力を生成します。

/**
 * @constructor
 */
var SomeClass = function(){}

/**
 * @param {SomeClass} someParam description
 */
var someFunc = function(someParam){}

つまり、JSDoc3 は someFunc のパラメーター リストから SomeClass のクラス記述へのリンクを正しく生成します。ただし、外部モジュールに SomeClass を配置すると、JSDoc3 にリンクを生成させることができないようです。

/**
 * @file SomeClass.js
 * @module SomeClass
 */

/**
 * @constructor
 */
exports.SomeClass(){}


/**
 * @file main.js
 */
var SomeClass = require('./SomeClass');

/**
 * @param {SomeClass} someParam description
 */
function someFunc(someParam){}

現在、JSDoc3 は両方のファイルのドキュメントを正しく生成しますが、someFunc のパラメーター タイプを SomeClass のページにリンクしません。私は次のものに置き換え@param {SomeClass}てみました：

  • @param {SomeClass.SomeClass}
  • @param {SomeClass/SomeClass}
  • @param {@link SomeClass}
  • @param {@link SomeClass.SomeClass}
  • @param {@link SomeClass/SomeClass}

しかし、これらのどれも機能しませんでした: すべての場合において、ドキュメントは中括弧内にテキストを表示するだけです (@link を使用した場合でも)。

JSDoc3 に外部モジュールへのリンクを正しく生成させるにはどうすればよいですか?

4

1 に答える 1

4

module:モジュールを参照するときは、プレフィックスを使用します。モジュールの戻り値がクラス自体である場合は、 を使用しますmodule:SomeClass。モジュールのプロパティである場合は、 を使用しますmodule:SomeClass.SomeClass。jsdoc が既存のクラス ドキュメントへの参照を見つけることができる場合、@link タグは必要ありません。

于 2013-03-05T01:55:21.213 に答える