La documentation des propriétés personnalisées dans les fichiers tsx est-elle possible?

Question

Semblable à la façon dont l'ide aide avec les descriptions lorsque je documente une fonction comme ça.

/** 
* My Test fn 
* @param a - some description here 
*/ 
function Test(a) {} 

Je voudrais l'ide de montrer une description dans le scénario suivant, mais je ne peux pas de dire quoi que ce soit, sauf « (JSX attributs) Test: booléen »

interface TestProps { 
    /** Some comment here */ 
    test: boolean; 
} 
class TestComp extends React.Component<TestProps, any> { 
    render() { 
     return <span>{this.props.test}</span> 
    } 
} 

const test = (props) => (
    <div><TestComp test={true} /></div> 
) 

Est-il possible de l'obtenir pour montrer la description en aidant avec la propriété de test?

Exemples:

Remarque l'image du bas a -certains la description ici et supérieur ne peut pas

Answer 1

Ceci a été corrigé avec tapuscrit 2.4 et 1.14 VSCode:

VSCode 1,14 navires avec TS 2.4 inclus. Vous pouvez vous assurer que TS 2.4 est actif en vérifiant la version TS dans le coin inférieur droit de la barre d'état VSCode

Vous pouvez également utiliser une version plus récente de TS dans une ancienne version de VSCode en suivant these instructions

S'il vous plaît let us know si vous avez d'autres problèmes avec cette

Answer 2

tapuscrit utilise JSDoc. /* Some comment here */ n'est pas valide JSDoc. /** Some comment here */ est la bonne façon de le faire.

Bug dans VSCode/tapuscrit

Au-delà du fait que le commentaire était faux. Un bogue n'a pas réussi à afficher les documents qui ont été corrigés dans TypeScript/VSCode.

Plus sur jsdoc

http://usejsdoc.org/about-getting-started.html