如何包含和排除使用documentationjs解析的目录

特别是，我对排除任何

node\u模块

文件夹感兴趣，但还有其他需要排除的文件夹

这通常在配置文件中完成；e、 例如，一个.jsdoc文件，如下所示：

"source": {
    "include" : ["../projects"],
    "includePattern": ".*src\\\\.+\\.js(doc|x)?$",
    "excludePattern": "(node_modules|docs)"
}

---

对我来说，最好的方法是用

@public

@private

等注释我的文档，然后传递选项

--access:['public'，'private']

来选择性地包含我想要的部分

< < /P> 您可以编写脚本以编程方式生成文档

documentation
    .build('src/index.js', { access: ["public"] })
    .then(documentation.formats.md)
    .then(markdown => {
      fs.writeFileSync('README.md'), markdown);
    })
    .catch(error => console.error(error));

编辑：

为了清楚起见，下面是如何使用console命令-

documentation build ./src/index.js --access private public protected -f html -o docs

---

你测试过这个吗？

--access

之后不应该有一个

：

，但即使我在没有

的情况下运行它，也会得到无效值：参数：access，给定：“[public”，“private]”，选项：“public”，“private”，“protected”，“undefined”

@erise我不确定您是如何运行它的，但是，如果您遵循第二段代码（我在其中编写了一个脚本来生成文档），那么您肯定可以将值作为数组传递。我在控制台中直接运行

documentation build src/index.js--access['public'，'private']

，这就是我的问题，我想我必须直接用文档来解决这个问题。但是我认为你的答案会受益于注意到它在他们的命令行中不起作用，这样我们这些带着不同用例来到这里的人就会知道这不是你给出的建议。@Erise当然，它不会起作用，因为你做得不对。您是否尝试过这样的

文档构建。/src/index.js——访问private-public-protected-f html-o文档

，这很有效。非常感谢。谢谢你的编辑。

documentation build ./src/index.js --access private public protected -f html -o docs