React Native - 如何记录一个组件？

Question

你如何评论 React 组件？

import React, { useState } from 'react';
import { Text, TextInput, View } from 'react-native';
import PropTypes from "prop-types";

const PizzaTranslator = ({ pizzaEmoji = ''}) => {
  const [text, setText] = useState('');
  return (
    <View style={{padding: 10}}>
      <TextInput
        style={{height: 40}}
        placeholder="Type here to translate!"
        onChangeText={newText => setText(newText)}
        defaultValue={text}
      />
      <Text style={{padding: 10, fontSize: 42}}>
        {text.split(' ').map((word) => word && pizzaEmoji).join(' ')}
      </Text>
    </View>
  );
}

PizzaTranslator.propTypes = {
   pizzaEmoji: PropTypes.string,
}

export default PizzaTranslator;

我正在记录我的 React Native (EXPO) 应用程序的组件。为此，我尝试安装

react-styleguidist.js

但是，在完成所有安装过程后，我遇到了多个与 expo webpack 配置相关的错误。

是否推荐使用像react-styleguidist这样的第三方库来自动生成可视化文档？或者使用 JSDOC 语法评论它们就足够了吗？

你推荐我什么来评论我的组件代码？您使用的任何图书馆或指南？

Answer 1

React Native Template 本身使用 JSDOC 语法来评论这样

/**
 * Sample React Native App
 * https://github.com/facebook/react-native
 *
 * @format
 * @flow strict-local
 */

import React from 'react';
...

所以我觉得够了

React Native - 如何记录一个组件？

React Native - How to document a component?

javascript

jsdoc

reactjs

react-native