我正在努力使用jsdoc-toolkit以下面的格式记录代码.它看起来像我使用的标签应该产生所需的结果,但它没有.相反,它警告：Class是未记录的(因为它仅在闭包中定义),并且不包括名称空间成员列表中的Class.
如果可能,我想将其记录下来,而无需使用@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
}
}();
解决方法
我尝试了一堆不同的东西,这是我能想出来的最好的.
第一部分…在Class上记录publicMethod.首先使Class成为一个memberOf命名空间,然后在Class.prototype上使用@lends.例：
/**
* @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
* @memberOf namespace
* @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";
};
Class.prototype =
/** @lends namespace.Class */
{
/** a public method
* @param {Object} argone The first argument
*/
publicMethod: function (argone) {
}
};
return {
Class: Class
}
}();
现在,第二部分…让Class显示在命名空间上.我不知道该怎么做…对不起！它将在类索引中显示为namespace.Class.
