2017-07-06 5 views
1

このような関数をドキュメント化するとき、ideが説明にどのように役立つかと似ています。tsxファイルのカスタムプロパティのドキュメントは可能ですか?

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

私は次のシナリオに説明を表示するには、IDEをしたいと思いますが、私はそれが「(JSX属性)テスト:ブール」以外のものを言うために得ることができない

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> 
) 

はどのような方法にはありますテストプロパティを手助けするときに説明を表示するようにしますか?

例:enter image description here

enter image description here

お知らせ下の画像はこちら - 一部の記述があり、トップが

答えて

0

の詳細これは、活字体2.4とVSCode 1.14で修正されました:

enter image description here

VSCodeが含まTS 2.4と1.14船。あなたは必ずTS 2.4はVSCodeのステータスバーの右下隅にあるTSのバージョンをチェックしてアクティブであることを確認することができます

enter image description here

またthese instructionsに従うことによってVSCodeの古いバージョンではTSの新しいバージョンを使用することができます

くださいlet us knowあなたはこの

+0

VSCode 1.14は正式にはまだリリースされていませんが、インサイダービルドでプレビューできます:https://code.visualstudio.com/insiders –

0

活字体はJSDocのを使用していません。 /* Some comment here */は有効なJSDocではありません。 /** Some comment here */は正しい方法です。 VSCodeで

バグ/コメントが間違っていたという事実を越えて活字体

。 TypeScript/VSCodeで修正されたドキュメントを表示できなかったバグがありました。

JSDocの

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

+0

でもない作品で、他の問題に実行する場合。私の例を更新しました – matthewdaniel

関連する問題