Question

我使用npm i -g测试了Doxygen和多个GitHub项目（jsdoc，react-docgen，react-doc-generator，如：

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

但没有人真正了解最近的ES6 JavaScript和JSX for React Native（甚至没有提到本机代码）。我最终得到了无用的文档。

当然，我尝试添加注释（和don的\ fn），但是注释完全由手工输入（未生成），有时文档中的代码不存在。

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

最后，我没有找到如何jsdoc文件夹和子文件夹（但评论文件中的测试结果是次要的）。

所以我转向React Native文档大师问：如何为React Native生成文档？

如果仅来自评论，您是否有工具从RN + ES6（+ Native）代码生成评论？

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

Answer 1

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

举一个例子，您可以看一下redux-higher-order-reducers ES6 code documented using ESDoc。

最后，我没有找到如何对文件夹和子文件夹进行jsdoc（但请进行测试评论文件的结果低于标准。

您可以在.esdoc.json配置文件中指定要记录的文件夹。这是一个仅将代码记录在“ src”文件夹中的示例

{
  "source": "./src",
  "destination": "./docs",
  "plugins": [
    {"name": "esdoc-standard-plugin"},
    {"name": "esdoc-jsx-plugin", "option": {"enable": true}}
  ]
}

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

ESDoc不能直接做到这一点，但是使用ESDoc的“手动”功能可以很容易地实现它，该功能允许您包括自己的文档。首先使用madge之类的东西从import语句生成图。例如：

./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 Native生成文档？

1 个答案: