JsDoc 工具包和命名空间 - 警告尝试..而不
我将 jsdoc-toolkit 与 Mike Koss 的命名空间库。代码如下所示
namespace.module('a.b', // this is the namespace
// @param {Object} exports visible classes within this namespace
// @param {function} required other namespaces
function (exports, require) {
var entityBase = require("a.base");
var util = require("a.util");
// @class BlaBla
// @constructor
// @property {String} ..
// @property {String} ..
// @property {String} ..
// @property {..} ....
// @param {Array} ...
// @param {X} [optionalParam]
exports.MyClass = function (...) {
创建文档 我收到以下消息并且根本没有为此类创建任何文档。
>> WARNING: Trying to document exports.MyClass without first documenting exports.
我尝试解决参数行的问题 - 没有成功。
// @param {Object} exports visible classes within this namespace
// @param {function} required other namespaces
function (exports, require) {
知道如何克服这个问题吗？
I am using jsdoc-toolkit with the namespace library of Mike Koss. The code looks like this
namespace.module('a.b', // this is the namespace
// @param {Object} exports visible classes within this namespace
// @param {function} required other namespaces
function (exports, require) {
var entityBase = require("a.base");
var util = require("a.util");
// @class BlaBla
// @constructor
// @property {String} ..
// @property {String} ..
// @property {String} ..
// @property {..} ....
// @param {Array} ...
// @param {X} [optionalParam]
exports.MyClass = function (...) {
Creating documentation I get the following message and no documentation is created at all for this class.
>> WARNING: Trying to document exports.MyClass without first documenting exports.
I have tried to overcome the issue with the param lines - no success.
// @param {Object} exports visible classes within this namespace
// @param {function} required other namespaces
function (exports, require) {
Any idea how to overcome the issue?
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（1）
我已切换到 JsDoc 3 (https://github.com/micmath/jsdoc#readme) 。该支持模块以及上述命名空间库。
I have switched to JsDoc 3 (https://github.com/micmath/jsdoc#readme). This support modules and hence the above namespace library.