Javascript 如何为React Native生成文档？

我测试了Doxygen和多个GitHub项目（，使用

npmi-g

如：

react-doc-generator ./ -o DOCUMENTATION.md
react-docgen --pretty -o out/reactdocgen.html ./
jsdoc ./src
doxywizard

但是没有人真正了解React Native的最新ES6 JavaScript和JSX（甚至不说本机代码）

当然，我曾尝试添加注释（对于doxygen，\fn），但注释完全是手工输入的（不是生成的），有时文档中的代码不存在

/**
 * 
 * 
 * @class MainScreen
 * @extends {Component}
 */
class MainScreen extends Component {
    /**
     * 
     * \fn navigationOptions()
     * @static
     * @memberof MainScreen
     */

最后，我没有找到如何

jsdoc

一个文件夹和子文件夹（但对一个注释文件的测试结果是不正确的）

因此，我转向React-Native文档大师询问：如何为React-Native生成文档

如果它仅来自注释，您是否有工具从RN+ES6（+本机）代码生成注释

优点：例如，我们可以从导入语句中自动获取图表吗？例如：

可以理解并记录ES6 JavaScript和JSX for React Native。它将记录代码，包括或不包括docblock注释。我将其与一起使用。正如其他人在注释中提到的，甚至还有支持最新ECMAScript建议的插件

关于您将得到的示例，您可以查看

最后，我没有找到如何jsdoc一个文件夹和子文件夹（但是测试了它） 已注释文件上的结果不完整）

您可以在

.esdoc.json

配置文件中指定要记录的文件夹

优点：我们可以从导入语句中自动获取图表吗 比如说

ESDoc不直接执行此操作，但使用ESDoc的“手动”功能很容易实现，它允许您包含自己的文档。首先使用类似于从导入语句生成图表的功能。例如：

./node_modules/.bin/madge --image manual/asset/graph.svg src/

接下来创建一个名为

manual/imports diagram.md

的文件，其中包含以下内容：

# Diagram of imports
![Diagram of imports](asset/graph.svg)

最后，更改ESDoc配置以指定用户手册部分：

{
  "source": "./src",
  "destination": "./docs",
  "plugins": [
    {
      "name": "esdoc-standard-plugin",
      "option": {
        "manual": {
          "asset": "./manual/asset",
          "files": [
            "./manual/imports-diagram.md"
          ]
        }
      }
    },
    {"name": "esdoc-jsx-plugin", "option": {"enable": true}}
  ]
}

---

再次运行

esdoc

，madge导入图将包含在您的文档中。

还尝试了

react-doxygen./-o./out-e js

从old With luckDid找到了解决方案？我也坚持这个问题。没有。我也很惊讶。airbnb是否有一些东西刚刚推出？对于es6和jsx支持，我已经使用了esdoc（esdoc.org）和两个插件（-）。然而，这不是一个react原生项目，但也许它仍然有点帮助

{
  "source": "./src",
  "destination": "./docs",
  "plugins": [
    {
      "name": "esdoc-standard-plugin",
      "option": {
        "manual": {
          "asset": "./manual/asset",
          "files": [
            "./manual/imports-diagram.md"
          ]
        }
      }
    },
    {"name": "esdoc-jsx-plugin", "option": {"enable": true}}
  ]
}