documentationjs / documentationjs/documentation

Support for flowtype Decalartions

Offen
#587 6 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement
Vorherrschende Sprache
JavaScript
Sterne
5.8k
Forks
481
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Here is an example of using a flowtype declaration to give a type annotation to a function:
```
/**
* test function returns true
*/
declare var test : () => boolean;
function test(){
return true;
}
```

The documentation produced does not capture the type annotation:
![image](https://cloud.githubusercontent.com/assets/810921/20118824/aee678de-a5cb-11e6-9a86-9cad0f48cbd7.png)

While if you use the syntax:
```
/**
* test function returns true
*/
function test() : boolean {
return true;
}
```

It produces the documentation which does capture the type annotation:
![image](https://cloud.githubusercontent.com/assets/810921/20118857/d431fb04-a5cb-11e6-89b3-89c042751b85.png)

Unclear to me how realistic it is to support flowtype's various syntaxes for type annotation without using flow directly to parse the file however.

Let me know if this fits into the scope for this project/repo.

flowtype declaration doc:
https://flowtype.org/docs/declarations.html

```
$ documentation --version
4.0.0-beta12
```

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Reproduziere das Problem mit den beiden JavaScript-Beispielen und der Dokumentationsversion 4.0.0-beta12 und lies anschließend die Deklarationsdokumentation von Flow, um den vorgesehenen Syntaxumfang zu ermitteln. Vergleiche die generierte Dokumentation für beide Beispiele und definiere „abgeschlossen“ als das Erfassen der Typannotation aus der Deklarationsform, ohne die bestehende Funktionssyntax zu beeinträchtigen.

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
28/100

Neue Issues direkt in Ihr Postfach

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