1

私は善良な市民になり、ノードモジュールを文書化しようとしています....しかし、@typeに何を入れればよいかわかりません。私は webstorm を使用しているため、自動的に @type {exports} が配置されますが、そこに何を配置すればよいか少し混乱していますか?

誰か手を貸してくれませんか?これは私が開発している小さなモジュールで、問題をより強調するためにコードを削除しました。@type を使用する必要があり、エクスポートを文書化して適切な説明を必要とする方法について混乱しています。

@type {exports} は有効なタグですか??

誰もが良い基準を知っているか、そこに意見を述べます/彼らが何を使用するか/または何を使用しているか

/**
 * A module for logging
 * @module logger
 * @type {exports}
 */


/**
 * HOW TO DOCUMENT THIS ???????????? GOOD DESCRIPTION??
 * @type {exports}
 */
var winston = require('winston');

/**
 * Returns an instance of the logger object
 * @param module
 * @returns {exports.Logger}
 */
function getLogger(module) {

    return new winston.Logger({
       ....
    });
}

/**
 * HOW TO DOCUMENT THIS ????????????  GOOD DESCRIPTION??
 * @type {getLogger}
 */
module.exports = getLogger;
4

2 に答える 2