Я очень стараюсь записать код в формате ниже с помощью jsdoc-toolkit. Мне кажется, что теги, которые я использовал, должны давать желаемый результат, но это не так. Вместо этого он предупреждает, что класс недокументирован (потому что он определен только внутри закрытия) и не включает класс в список членов пространства имен.
Я хотел бы документировать это, не прибегая к использованию тега @name, если это возможно. Может ли кто-нибудь помочь?
/**
* @namespace The original namespace
*/
var namespace = function () {
// private
/**
* @private
*/
function _privateMethod () {
};
/**
* This is the detail about the constructor
* @class This is the detail about the class
* @param {Object} argone The first argument
* @param {Object} argtwo The second argument
*/
var Class = function (argone, argtwo) {
/**
* A public member variable
*/
this.member = "a member";
};
/**
* A public method
* @param {Object} argone The first argument
*/
Class.prototype.publicMethod = function (argone) {
};
return /** @lends namespace */ {
Class: Class
}
}();