2016-08-26 7 views
4

jsソースをフロータイプアノテーションで処理しようとすると、jsdocパーサーは拡張構文を理解できません!フロータイプのアノテーションで拡張されたjsソースでjsdocを使用する方法がありますか、またはアノテーション付きのjs型からドキュメントを生成するための推奨される方法はありますか?フロータイプアノテーションを持つjsでjsdocを使用

答えて

3

strip-flow-typeトランスフォームでbabelを使用し、このjsdoc pluginを使用できます。

まず、jsdocの上にbabelと関連パッケージとjsdoc-babelをインストールする必要があります。例えば、あなたがJSDocの-バベルで任意の有効なバベルのセットアップを使用することができます

{ 
    "plugins": ["node_modules/jsdoc-babel"], 
    "babel": { 
     "presets": ["react"], 
     "plugins": ["transform-react-jsx", "transform-flow-strip-types"] 
    } 
} 

:次に、このような何かを含む、あなたのルートディレクトリにJSDocの-conf.jsonファイルを作成しますES2015またはその他のバベルプラグイン用のプリセット。お役に立てれば!

+0

この回答は、実用的なコード例を提供することで改善される可能性があります。ところで、stackoverflowへようこそ! – byxor

4

ちょうどdocumentation.jsを使用して開始しました。 JSdocをサポートし、箱から出てきます。

関連する問題