0

シンプルな 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 出力では に関する情報を見つけることができますが、CLI 出力のどこにtestFunctionも情報がまったく見つからないことです。testFunctionHTML コードも検索しましたが、何もありませんでした。

それで、私は何か間違ったことをしましたか？私はこの時点で同等性を達成しようとしているだけであり、オンラインで見つけることができるすべてのドキュメントを使い果たしました。

4

1 に答える 1

0

こちらの gulp-jsdoc github ページを見ると、このプラグインが最新の状態に保たれていないという「大きな警告」があります。

gulp-shell プラグインを使用してみてください。コマンドラインに入力した内容を正確に使用できます。

于 2015-04-20T22:03:20.223 に答える