reactjs / reactjs/react-docgen
Generate docs for hooks
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 3.8k
- Fork
- 316
- Merge medio
- 5h 7m
- PR unite (30g)
- 4
Descrizione
Since hooks have been released a while back, it would be nice to be able to generate docs for them.
For example, for a simple hook:
import {useState} from 'react';
/**
* A hook to do something
*
* @param {object} params
* @param {boolean} [params.disabled] Disable the thing
* @returns {boolean}
*/
const useMyHook = (params) => {
const [isUsing, setUsing] = useState(false);
// Some logic here to invoke setUsing()
return isUsing;
};
export default useMyHook;
There is not way to generate some docs. Or is there and I just can't find it?
NOTE: I am actually using react-styleguidist which uses this lib to generate component docs.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Non è indicato alcun file sorgente né alcun test. Inizia esaminando il percorso di generazione esistente di react-docgen e l'integrazione con react-styleguidist citata nell'issue; il lavoro è completato quando gli hook con JSDoc, come nell'esempio, producono documentazione generata utilizzabile.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- react, typescript
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 35/100