Как использовать JSDo c для документирования моей структуры? - PullRequest
0 голосов
/ 06 мая 2020

Ниже представлена ​​структура моего кода:

const kind = [];

kind.sample= factory( function() {

const sample = {};
sample.init = function() {...}

const privateFunction = function() {...}

return sample;

} );

function factory( protoFn )
{
return () => Object.create( protoFn() );
}

kind.sample();

И вот как я пытался задокументировать это до сих пор:

/**
 * @namespace kind
 * @description keeps references of objects' factory functions.
*/
const kind = [];

/**
 * @description define prototype function
 * @method
*/
kind.sample= factory( function() {

/**
 * @namespace kind.sample <- does not work
 * @description prototype
*/    
const sample = {};

 /**
 * @memberof kind.sample
 */
sample.init = function() {...}

/**
 * @private
 */
const privateFunction = function() {...}

return sample;

} );

function factory( protoFn )
{
return () => Object.create( protoFn() );
}

kind.sample();

Как вы можете видеть выше, я хочу создать пространство имен sample в пространстве имен kind. JSDo c генерирует его в пространстве имен kind, но когда я нажимаю на него, ничего не происходит, и я не вижу методов (например, init). Однако, если я создам его как отдельное пространство имен, например sample, он будет работать нормально. Не могли бы вы сказать мне, как я могу поместить пространство имен sample в качестве вложенного пространства имен под kind?

...