How to create documentation for React Native?

I tested Doxygen and several GitHub projects ( jsdoc , react to docgen , react to doc -g, using npm -gfor example:

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

But no one really understands the recent ES6 JavaScript and JSX for React Native (not to mention native code). I end up with useless documentation.

Of course, I tried to add comments (and \ fn for doxygen), but comments are completely entered manually (not generated), and sometimes there is no code in the documentation.

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

Finally, I did not find how to make the jsdocfolder and subfolders (but the test results for the commented out file were lower).

React Native : React Native?

, RN + ES6 (+Native)?

: , , ? : app-diagram

+20
1

ESDoc ES6 JavaScript JSX React Native. . ESDoc JSX. , , ECMAScript.

, , ES6 redux- -, ESDoc.

, , jsdoc ( ).

, .esdoc.json. , "src"

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

: , , ?

ESDoc , , "" ESDoc, . - madge . :

./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 , .

0

All Articles