Como fazer a documentação em ReactJS?
Tenho de criar o ficheiro doc de cada um dos componentes.
nós definimos em nossa aplicação reactjs.Estou à procura do MPN que nós
pode usar para criar o documento de qualquer extensão, para que possa
extrair o código, comentar tudo do meu componente e mudar isso
ao documento de qualquer extensão.Como posso fazer isso, por favor, ajudar-me? Minha pergunta é diferente da outra pergunta encontrada a respeito do jsdoc, porque eu estou procurando a documentação em reactjs usando jsdoc.
5 answers
Finalmente encontrei a solução, Primeiro vá para este link e leia o documento corretamente.:-
Leia O Documento
Agora faça os seguintes passos:-
Abra a sua linha de comandos
Instale o JSDoc globalmente por comando: MPN instale jsdoc-g
Vá agora para a localização da pasta do seu projecto e execute o comando: JSDoc src-r-d docs
O comando acima irá criar o documento na pasta doc da pasta do seu projecto.
13
Author: jack123, 2017-01-30 09:59:22
Documentamos a nossa biblioteca de componentes React usando O Estileguidismo React .
Irá processar o seu código com as seguintes características:
- gerar docs API / props a partir dos PropTypes que definir.
- crie documentação de exemplos editáveis ao vivo que permita às pessoas copiar o colar facilmente.
- é bastante configurável e tem recarga a quente para conseguir documentos internos.
Ele funciona através da construção de uma aplicação web através do Webpack, que você pode usar localmente ou hospedar em algum lugar para todos os seus desenvolvedores.
Para nós, funciona muito bem e eles melhoram com o tempo.
Editar: Is uses reat-docgen sob o capô.
7
Author: Amida, 2017-04-28 07:59:10
Tente este pacote que tem exemplos para você entender.
Fornece uma implementação predefinida para os componentes React definidos via React.createClass, definições ou funções de classe ES2015 (componentes apátridas). Estas definições de componentes devem seguir certas diretrizes, a fim de serem analisáveis (veja abaixo para mais informações).
Https://www.npmjs.com/package/@rtsao/react-docgen
Temos um monte de lips componentes react e usar reat-showroom
Permite escrever documentação em markdown e ter Caixa de areia.
Uma grande vantagem disso - você pode iniciar um novo projeto em dois minutos com webpack já configurado, babel, cotão, etc.
Muito recomendável tentar.
Escrevi uma pequena embalagem para o reat-docgen, o que torna um pouco mais simples trabalhar isso. Ele exporta um arquivo markdown para todos os Componentes da pasta passada.
Verifique o projecto https://github.com/LaustAxelsen/wilster-doc