43

メソッドを提供するjQueryの$.widget()基本「クラス」を使用しています。option()メソッドが私のコードにないので、引数を文書化する場所がありません。

デフォルトのオプションリテラルのフィールドにjsDocを配置しようとしましたが、それらは単に選択されていません。@class次に、同じオブジェクトリテラルでタグとタグを使用しようとしまし@lendsたが、オブジェクトリテラルは実際にはクラスではないため、これはかなり混乱する可能性があります。

私が実験したもう1つの方法は@param options.field description、コンストラクターのjsDocに次のようなものを入れることです。ただし、これには、ドキュメントをコードから分離するという欠点があります。optionsまた、コンストラクターには、すべてjQueryによって処理されるため、実際には呼び出される引数はありません。

Javascriptの達人はこれをどのように処理しますか？新しいタグを提案する必要がありますか？

4

1 に答える 1

95

私があなたの質問を正しく理解していれば、オプション オブジェクトを受け取る関数があり、そのすべてのメンバーを文書化したいですか?

JSDoc でこれを行う方法の大まかな例は次のとおりです。

/**
 * @description
 * Compliment someone on their something.
 *
 * @param {Object} options
 * @param {String} options.name    A person's name
 * @param {String} options.feature A person's property
 */
function flatter (options) {
  options = options || {};
  console.log('%s, loving your %s!', options.name, options.feature);
}
于 2013-02-11T20:50:46.023 に答える