如何在 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中输出文档。