Question

我正在尝试为一组简单的JS代码构建文档（如下所示）。如果我使用gulp，那么文档将被创建为我所期望的。如果我使用CLI，则文档不完整。

这是我的JS代码：

// BASE.js
/** @module BASE */
var BASE = {};

// MOD1.js
/** @class MOD1 - Test module */
BASE.MOD1 = Object.create({});

/**
 * Just a test function
 * @param {Object} var1 - A test variable
 */
BASE.MOD1.testFunction = function(var1){
    alert('hi');
};

我的gulp文件：

var gulp = require('gulp'),
    jsdoc = require('gulp-jsdoc'),
    outDir = './gulp-docs/',
    docInfo = {},
    docOptions = {},
    docTemplate = {},
    srcFiles = [
        "BASE.js",
        "MOD1.js"
    ];

gulp.task('default', function() {
    return gulp.src(srcFiles)
            .pipe(jsdoc.parser(docInfo))
            .pipe(jsdoc.generator(outDir, docTemplate, docOptions))
});

我的命令行：

C:\DocTest> jsdoc BASE.js MOD1.js --configure rawconf.json --destination raw-docs

rawconf.json：

{
    "tags": {
        "allowUnknownTags": true
    },
    "plugins": [],
    "templates": {},
    "opts": {
        "package": "./rawpackage.json"
    }
}

rawpackage.json：

{}

我从Node.js命令提示符下运行gulp和jsdoc命令。

gulp的输出是以下文件：

BASE.js.html
BASE.MOD1.html
index.html
MOD1.js.html
module-BASE.html

CLI的输出是以下文件：

BASE.js.html
index.html
MOD1.js.html
module-BASE.html
module-BASE-BASE.MOD1.html

我可以通过gulp-jsoc版本的jsdoc（3.3.0-alpha5）和当前版本（3.3.0-beta3）之间的差异来解决一些小的差异。

但最大的区别在于，在gulp输出中，我可以找到关于testFunction的信息，但在CLI输出中的任何地方都没有关于testFunction的信息。我甚至搜索过HTML代码 - 没什么。

我做错了什么？我只是想在这一点上实现平价，而且我已经用尽了我在网上找到的任何文件。

Answer 1

如果你看一下gulp-jsdoc github页面here，那就有一个＆＃34; Big Fat Warning＆＃34;这个插件没有及时更新。

尝试使用gulp-shell插件。您可以使用您在命令行中输入的内容。

gulp-jsdoc＆amp;和JSDoc输出不一致标准CLI

1 个答案: