documentationjs / documentationjs/documentation
Improve Support for @memberof inference with ES6 modules
- Lingua principale
- JavaScript
- Stelle
- 5.8k
- Fork
- 481
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
A common pattern in modern js web development is to have several named utility modules with named and default exports.
It would be ideal if `documentation.js` was smart enough to infer the membership status of private and exported methods that were documented inside the module.
I've set up a demonstration to illustrate what I'm after here:
https://github.com/ajhyndman/documentation-js-demo/commit/9ef86935e7682fb0d3217c534c53b1a86a49c086
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Inizia esaminando il commit collegato documentation-js-demo e confronta i suoi export ES6 denominati e predefiniti con la documentazione generata. Quindi traccia il modo in cui documentation.js gestisce attualmente l’inferenza di @memberof per i metodi documentati all’interno dei moduli. Il lavoro è completato quando i metodi privati ed esportati ricevono lo stato di appartenenza previsto nella documentazione generata, con una copertura per il modello di modulo mostrato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 30/100