如何在多个.js文件中解析JSDoc

时间:2015-03-15 15:42:14

标签: javascript json node.js gulp jsdoc

我有很多javascript文件。我需要使用一些jsdoc解析器(gulp-jsdocjsdoc-parse或其他)来提取jsdoc。

使用以下方法,我得到一个巨大的dist/documentation.json文件,其中包含我所有脚本的JSON。

var jsdoc = require("gulp-jsdoc");    
gulp.src("mysrc/*/*.js")
    .pipe(jsdoc.parser({}, "documentation.json"))
    .pipe(gulp.dest('dist'));

但我需要尽可能多的小.json个文件和我拥有的.js个文件。

第二种方式。使用jsdoc-parse我遇到了另一个麻烦。我不知道如何正确地将结果写入文件而不是process.stdout

var parse = require("jsdoc-parse");
var tap = require('gulp-tap');
gulp.src("mysrc/*/*.js")
     .pipe(tap(function(file) {
          parse(file.path).pipe(process.stdout); // how to write it to file?
     });

请帮我完成这个Gulp任务。

1 个答案:

答案 0 :(得分:0)

我用gulp-jsdoc解决了这个问题。

var gulp = require('gulp');
var jsdoc = require("gulp-jsdoc");   
var tap = require('gulp-tap'); 

gulp.task('jsdoc', function() {
  gulp.src("mysrc/*/*.js")
    .pipe(tap(function (file) {
      gulp.src(file.path)
        .pipe(jsdoc.parser({}, file.relative))
        .pipe(gulp.dest('./dist'));
    }));
});

但如果有人帮助我使用jsdoc-parse重写任务,那仍然会很好。 jsdoc-parse会产生更好的JSON。