Javascript 如何使用JSDoc3注释JS模块模式类?
我实际上就是这样做的,但是在生成文档之后,私有方法和属性是不可见的 我做错什么了吗 顺便说一句,其他一切都很好。我第一次使用文档生成器,我印象深刻Javascript 如何使用JSDoc3注释JS模块模式类?,javascript,documentation,jsdoc,module-pattern,Javascript,Documentation,Jsdoc,Module Pattern,我实际上就是这样做的,但是在生成文档之后,私有方法和属性是不可见的 我做错什么了吗 顺便说一句,其他一切都很好。我第一次使用文档生成器,我印象深刻 /** * Constructor Description * @constructor * @class * @classdesc Something about my class Foo. */ container.Foo = function() { this.init(); }; container.Foo.prototype =
/**
* Constructor Description
* @constructor
* @class
* @classdesc Something about my class Foo.
*/
container.Foo = function() { this.init(); };
container.Foo.prototype = (function() {
/**
* @private
* @name container.Foo~fooPropertyPrivat
* @property {boolean} fooPropertyPrivat Some description
*/
var fooPropertyPrivat = true;
/**
* Some description
* @private
* @name container.Foo~doSomethingPrivat
* @memberOf container.Foo
* @method doSomethingPrivat
*/
function doSomethingPrivat() {
//...
}
return {
/**
* @public
* @name container.Foo#fooPropertyPublic
* @property {boolean} fooPropertyPublic Some description
*/
fooPropertyPublic: true,
/**
* Some description
* @public
* @constructs
* @name container.Foo#init
* @memberOf container.Foo
* @method init
*/
init: function() {
//...
}
};
})();
拉斐尔,我很高兴听到JSDOC3到目前为止为您工作得很好 默认情况下,JSDoc会忽略任何带有
@private
标记的符号。您可以使用--private
命令行选项覆盖此设置