gulp-jsdoc 和标准 CLI 之间的 JSDoc 输出不一致答案

【问题标题】：JSDoc output inconsistent between gulp-jsdoc & standard CLIgulp-jsdoc 和标准 CLI 之间的 JSDoc 输出不一致
【发布时间】：2015-04-21 06:03:20
【问题描述】：

我正在尝试为一组简单的 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

我可以将一些小的差异归结为 jsdoc 的 gulp-jsoc 版本 (3.3.0-alpha5) 和当前版本 (3.3.0-beta3) 之间的差异。

但最大的不同是，虽然在 gulp 输出中，我可以找到有关 testFunction 的信息，但在 CLI 输出的任何地方都找不到有关 testFunction 的信息。我什至搜索了 HTML 代码——什么都没有。

那我做错了吗？我只是想在这一点上实现平等，我已经用尽了我可以在网上找到的所有文档。

【问题讨论】：

标签： jsdoc jsdoc3

【解决方案1】：

如果您查看 gulp-jsdoc github 页面 here，则会出现“大胖警告”，表明此插件未保持最新。

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

【讨论】：

感谢有关 gulp-shell 的提示，但问题实际上是相反的，因为 CLI 输出已损坏。这更像是一个 jsdoc CLI 问题，而不是 gulp-jsdoc 问题。我实际上正在尝试从 gulp-jsdoc 迁移以使用 CLI，但上述问题目前正在阻止。