我的模块有以下AMD结构。
/* globals define */
define([""], function() {
'use strict';
var module = {};
function _somePrivateFunc() {}
function somePublicFunc() {}
module.somePublicFunc = somePublicFunc;
return module;
});
我正在努力使用JSDoc来使其与我的模块一起工作。到现在为止,我可以让它像
一样工作/* globals define */
/**
* Module description here
* @module some/module/name
*/
define([""], function() {
'use strict';
/**
* @alias module:some/module/name
*/
var module = {};
function _somePrivateFunc() {}
function somePublicFunc() {}
/**
* Some property description here
* @itWorks
*/
module.somePublicFunc = somePublicFunc;
return module;
});
如你所见,它正在发挥作用。但我想在函数声明中定义我的doc注释,而不是将它们添加到模块中。我想实现这个目标:
/* globals define */
/**
* Module description here
* @module some/module/name
*/
define([""], function() {
'use strict';
/**
* @alias module:some/module/name
*/
var module;
/**
* Somehow make this appear in JSDoc
* @extend module:some/module/name
* @private
*/
function _somePrivateFunc() {}
/**
* Make this appear in JSDoc for sure.
*/
function somePublicFunc() {}
// I want this to NOT annotate, and I want the property to gather JSDoc
// from the func. declaration
module = {
somePublicFunc: somePublicFunc
};
return module;
});
后者是我想要实现的目标,但遗憾的是它不起作用:(
有什么想法吗? 干杯
我取得了一些进展。记住,如果我只写这个:
define('dep', function(require) {
/**
* @exports dep
*/
var module = {};
/**
* Adds two numbers together.
* @param {Number} a the first number
* @param {Number} b the second number
* @return {Number} the sum of a and b
*/
function sum(a, b) {
return a + b;
}
module.sum = sum;
return module;
});
然后输出为空。 JSDoc无法正确生成文档。虽然如果我在我的函数中添加@method <name>
注释,那么它会自动运行得很好。有趣的是,但只添加一个没有名称的@method
注释是不够的。我的最终工作解决方案如下:
define('dep', function(require) {
/**
* @exports dep
*/
var module = {};
/**
* Adds two numbers together.
* @func sum
* @param {Number} a the first number
* @param {Number} b the second number
* @return {Number} the sum of a and b
*/
function sum(a, b) {
return a + b;
}
/**
* Creates a closure. Adds two numbers together
* @func _add
* @param {Number} a the closure variable to add statically
* @return {Function} the closure
* @private
*/
function _add(a) {
return function(b) {
return a + b;
};
}
module.sum = sum;
return module;
});
CLI标志-p
使私人成员出现在文档中。
我只能通过示例代码中的一个方式创建内部链接:
/**
* Adds two numbers together.
* @func sum
* @param {Number} a the first number
* @param {Number} b the second number
* @return {Number} the sum of a and b
* @see {@link module:dep~_add|_add}
*/
function sum(a, b) {
return a + b;
}