这就是我实际执行此操作的方式,但是在生成文档后私有(private)方法和属性不可见。
我是不是做错了什么?
顺便说一句,其他一切正常。我第一次使用文档生成器,给我留下了深刻的印象。
/**
* 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() {
//...
}
};
})();
最佳答案
Raphael,我很高兴听到 JSDoc 3 到目前为止对您来说运行良好!
默认情况下,JSDoc 会忽略任何用 @private
标记的符号。您可以使用 --private
命令行选项覆盖此设置。
关于javascript - 如何使用 JSDoc3 注释 JS 模块模式类?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/15743347/