是否有任何包可以让你记录你的gruntfile，类似于apiDocs for Node？

Question

我有一个很棒的项目，里面有很多繁琐的任务。问题是，它很臃肿。仅gruntfile.js就有1200多行。我希望能够通过像apiDocs这样的代码中的注释来记录我安装的所有这些grunt插件。有没有这样做的包？或者，是否有一种不同的方式来记录您的grunt文件？

Answer 1

如果您的Grunt文件长度为1200行，我强烈建议您split it into multiple files。

你gruntfile只是一个NodeJs应用程序，这意味着它是用JS编写的，而最流行的JS编辑器是JSDoc。

所以任务看起来像：

<强>咕噜/ uglify.js

/**
 * Minify javascript files
 *
 * @description
 * Here is a detailed explanation of what this uglify task can do
 * 
 * @type {Object}
 */
module.exports = {
  dist: {
    files: {
      'dist/build.min.js': ['dist/build.js']
    }
  }
};