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

How to parse JSDoc in multiple .js files

本文关键字：JSDoc 文件 js      更新时间：2023-09-26

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

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

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

但是我需要与我拥有的.js文件一样多的小分离.json文件。

第二种方式。使用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 任务。

我用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。

相关文章：