documentationjs / documentationjs/documentation

Improve Support for @memberof inference with ES6 modules

Offen
#488 1 Kommentar 5 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
JavaScript
Sterne
5.8k
Forks
481
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, den verknüpften documentation-js-demo-Commit zu überprüfen, und vergleiche dessen benannte und standardmäßige ES6-Exports mit der generierten Dokumentation. Verfolge anschließend, wie documentation.js derzeit die @memberof-Inferenz für Methoden handhabt, die innerhalb von Modulen dokumentiert sind. Als erledigt gilt die Aufgabe, wenn private und exportierte Methoden in der generierten Dokumentation den vorgesehenen Mitgliedschaftsstatus erhalten und eine Abdeckung für das demonstrierte Modulmuster vorhanden ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.