如何在reactjs中使用Jsdoc生成文档？

Question

我已经在命令npm install jsdoc的帮助下在我的解决方案中安装了Jsdoc。现在在方法中我已将评论定义为： -

/**
 * @param {object} state person/thing you want to say hello to.
 * @param {object} action
 * @returns {object} state
 */

现在的问题是如何生成文档？生成文档的命令是什么？

Answer 1

首先，您可以查看documentation。 起初有点令人困惑，但相当全面。

然后，我建议使用 npm -g

全局安装jsdocs

现在您可以转到项目文件夹，然后输入

jsdoc src -r -d docs

这将遍历子目录 src 中的所有文件，并在 docs 中输出文档。