documentationjs / documentationjs/documentation
Support for flowtype Decalartions
- Lingua principale
- JavaScript
- Stelle
- 5.8k
- Fork
- 481
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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:

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:

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
```
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Riproduci il problema con i due esempi JavaScript e la versione 4.0.0-beta12 della documentazione, quindi leggi la documentazione delle dichiarazioni di Flow per identificare la copertura sintattica prevista. Confronta la documentazione generata per entrambi gli esempi e definisci come completamento l’acquisizione dell’annotazione di tipo dalla forma di dichiarazione senza introdurre regressioni nella sintassi di funzione esistente.
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
- 28/100