2

EventEmitterクラスからイベント ハンドラーを削除する関数があります。次のようになります。

EventEmitter.prototype.remove_handler = function(event_name, handler) {
    if(arguments.length < 2) {
        handler = event_name;
        event_name = null;
    }

    // ...
};

この関数は、イベント名とハンドラーを指定して呼び出すことも、ハンドラーのみを指定して呼び出すこともできます。イベント名が存在する場合、ハンドラーはその特定のイベントから削除されます。そうでない場合、イベント エミッターから完全に削除されます。

このようなシナリオを JsDoc で文書化するにはどうすればよいですか? この場合、パラメーターが表示されるときにドキュメントを作成し、「event_name は省略できます。その場合は (etc...)」と注意することもできますが、それが不可能なシナリオも確かに想像できます。

4

1 に答える 1

3

タグを使用し@alsoて、複数のメソッド シグネチャを提供できます。

/**
 *
 * @param {String} event_name
 * @param {Function} handler
 *
 * @also
 *
 * @param {Function} handler
 */
EventEmitter.prototype.remove_handler = function(event_name, handler) {
于 2014-04-04T00:25:40.497 に答える