[英]How to comment a JS module pattern class using JSDoc3?
這就是我實際執行此操作的方式,但在生成文檔后,私有方法和屬性是不可見的。
我做錯了什么?
順便說一下,其他一切都很好。 我第一次使用文檔生成器,我印象非常深刻。
/**
* 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() {
//...
}
};
})();
拉斐爾,我很高興聽到JSDoc 3到目前為止對你有用!
默認情況下,JSDoc省略了用@private
標記的任何符號。 您可以使用--private
命令行選項覆蓋此設置。
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.