reactjs / reactjs/react-docgen
Generate docs for hooks
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 3.8k
- Forks
- 316
- Ø Merge
- 5 Std. 7 Min.
- Gemergte PRs (30 T.)
- 4
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Es wird keine Quelldatei und kein Test genannt. Beginne damit, den bestehenden Generierungspfad von react-docgen und die im Issue erwähnte react-styleguidist-Integration zu untersuchen; abgeschlossen ist die Aufgabe, wenn Hooks mit JSDoc wie im Beispiel eine nutzbare generierte Dokumentation erzeugen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- react, typescript
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100