gpt4 book ai didi

javascript - 为什么这个对象字面量没有呈现给 JSDoc?

转载 作者:行者123 更新时间:2023-11-28 00:23:40 24 4
gpt4 key购买 nike

我有以下 JavaScript。

它是一个 RequireJS 模块,其函数被命名为对象文字。我提到:How do I JSDoc A Nested Object's Methods?了解如何标记 JSDoc 符号。

我在 grunt 任务中使用 private: true 运行 JSDocs 3.3.0-beta3,但在模块页面上没有私有(private)方法或 publich 方法的参数。

/**
* A module doing a lot of Foo.
* @module Foo
* @requires jquery
* @author Markus Falk
*/
define(['jquery'], function($) {

'use strict';

/**
* @property {Object} Container
*/
var Foo = {
/**
* Caches all jQuery Objects for later use
* @function
* @private
*/
_cacheElements: function() {
this.$foo = $('.foo');
},
/**
* inits the app and returns the Message Text
* @function
* @public
* @param {Object} msg - The message.
* @param {string} msg.text - The message's Text.
* @param {string} msg.author - The message's author.
* @returns {String} Sentence with given message.text
*/
init: function(msg) {
this._cacheElements();
return "Say " + msg.text;
}
};

return /** @alias module:Foo */ {
/** init */
init: Foo.init
};
});

这是此 JSDoc 代码的输出:

JSDocs

最佳答案

尝试@function init@function _cacheElements

/**
* A module representing a Foo.
* @module Foo
* @requires jquery
* @author Markus Falk
*/
define(['jquery'], function($) {

'use strict';

/**
* @property {Object} Container
*/
var Foo = {
/**
* Caches all jQuery Objects for later use
* @function _cacheElements
* @private
*/
_cacheElements: function() {
this.$foo = $('.foo');
},
/**
* inits the app and returns the Message Text
* @function init
* @public
* @param {Object} msg - The message.
* @param {string} msg.text - The message's Text.
* @param {string} msg.author - The message's author.
* @returns {String} Sentence with given message.text
*/
init: function(msg) {
this._cacheElements();
return "Say " + msg.text;
}
};

return /** @alias module:Foo */ {
/** init */
init: Foo.init
};
});

enter image description here

关于javascript - 为什么这个对象字面量没有呈现给 JSDoc?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/29749745/

24 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com