javascript - 是否有任何软件包可以让您记录 gruntfile，类似于 Node 的 apiDocs？

Question

已结束。此问题正在寻求书籍、工具、软件库等的推荐。它不满足 Stack Overflow guidelines 。目前不接受答案。

---

我们不允许提出寻求书籍、工具、软件库等推荐的问题。您可以编辑问题，以便用事实和引文来回答。

已关闭 5 年前。

Improve this question

我已经建立了一个很棒的项目，其中有大量繁重的任务。问题是，它臃肿了。 gruntfile.js仅此一项就有1200多行。我希望能够通过像 apiDocs 这样的代码中的注释来记录我安装的所有这些 grunt 插件。做。有没有任何软件包可以做到这一点？或者，是否有不同的方法来记录您的 grunt 文件？

Answer 1

如果你的Gruntfile有1200行长，我强烈建议你split it into multiple files .

You gruntfile 只是一个 NodeJs 应用程序，这意味着它是用 JS 编写的，最流行的 JS 文档是 JSDoc .

因此任务可能如下所示:

grunt/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']
    }
  }
};