我使用jsdoc.app记录了我的项目。我有A类,它具有几个功能。有些返回Promise,有些返回String。
奇怪的是,没有一个回报显示说明。 @return {Promise} A promise ...
或@return {String} It returns ...
这是我的示例代码
/**
* Return test path.
*
* @param {string} project
* @param {string} test
* @returns {string} path.
*/
testPath(project, test) {
return project + test;
}
它显示参数,其他按预期返回,没有返回描述。
testPath(project, test) → {string}
Return test path.
PARAMETERS:
Name Type Description
project string
test string
这是我的jsdoc配置文件
'use strict';
module.exports = {
opts: {
readme: './README.md',
package: './package.json',
template: './node_modules/jsdoc-fresh',
recurse: true,
verbose: true,
destination: './docs/'
},
plugins: [
'plugins/markdown',
'jsdoc-region-tag'
],
source: {
excludePattern: '(^|\\/|\\\\)[._]',
include: [
'build/src',
'protos'
],
includePattern: '\\.js$'
},
templates: {
includeDate: false,
sourceFiles: false,
theme: 'lumen',
default: {
outputSourceFiles: false
}
},
markdown: {
idInHeadings: true
}
};
如果您需要任何其他信息,请告诉我。非常感谢。