Распознает ли JSDoc назначение члена - PullRequest
Новая
       9

Распознает ли JSDoc назначение члена

0 голосов
/ 16 мая 2018

Я думаю, что обычной практикой является разделение публичных и частных членов следующим образом: 

// lib/index.js
exports.publicFunc = require('./private').internalFunc;

// lib/private.js
/**
 * My private function
 *
 * @param {string} foo some foo
 * @return {number} bar value
 */
exports.internalFunc = foo => 42;

С этим я запускаю jsdoc lib/index.js, но ничего не получаю.Если я запускаю jsdoc lib, то также отображается internalFunc, который я хотел бы скрыть.JSDoc предназначен для такого случая?Если так, как я могу сгенерировать JSDoc для такого пакета?Я не хочу повторять документацию, поэтому я не буду копировать эту документацию в lib/index.js.

...