Docz: 高度なtypescriptアノテーションの統合

作成日 2018年06月12日  ·  3コメント  ·  ソース: doczjs/docz

やあ、

Doczをどうもありがとう、私はいつも他のツールで問題を抱えていました、そしてDoczはちょうどうまくいきます。 TypescriptとPropsTable統合は素晴らしいので、もっと高度な統合についての議論を始めたいと思います。

  • JSのデフォルト関数パラメーターでデフォルト値をサポートします。つまりfunction MyComponent({text = "hello"}) {}
  • IDEで使用されているtypescript言語サーバーによって現在処理されているように、パラメーターの上にJSコメントを含む説明をサポートします。
    `` `js
    関数MyComponent({
    / *

    • 「テキスト」パラメータのドキュメント

      *
    /

    text = "hello"

    })

  • 通常の関数をサポートしますが、パラメーターの入力やインラインパラメーターのドキュメントなど、Reactコンポーネントだけではありません。
  • Voilà、あなたはすでにこれらの項目について考えていると思いますが、私はそれについてオープンな議論をするのは良いことですが。

    question

    最も参考になるコメント

    @mquandalleが気に入ってくれてうれしいです。 私は最近、たくさんのプロジェクトでtypescriptをよく使用しています。正直なところ、すべてのプロジェクトでtypescriptを使用していて、とても気に入っています。 残念ながら、時間があまりなかったので、このアノテーション統合をすでに行うツールを選択することになりました。 このバージョンのdoczでは、 react-docgenを使用してプロパティテーブルを生成していますが、制限があり、多くのトレードオフがあり、パフォーマンスの問題になる可能性があります😢これらのトレードオフの1つは、typescriptを使用したデフォルトのプロパティに関するものです。 フロー統合はtypescriptよりもはるかに優れています!

    たぶん将来的には、これらの問題を修正するために何かを作成したり、react-docgenを改善したりするのは良いことです。

    通常の関数の注釈については、これは素晴らしいことであり、doczを使用して実行するのは本当に簡単で実行可能なことだと思います。 私は今週それについて考えています、そしてまでの

    全てのコメント3件

    @mquandalleが気に入ってくれてうれしいです。 私は最近、たくさんのプロジェクトでtypescriptをよく使用しています。正直なところ、すべてのプロジェクトでtypescriptを使用していて、とても気に入っています。 残念ながら、時間があまりなかったので、このアノテーション統合をすでに行うツールを選択することになりました。 このバージョンのdoczでは、 react-docgenを使用してプロパティテーブルを生成していますが、制限があり、多くのトレードオフがあり、パフォーマンスの問題になる可能性があります😢これらのトレードオフの1つは、typescriptを使用したデフォルトのプロパティに関するものです。 フロー統合はtypescriptよりもはるかに優れています!

    たぶん将来的には、これらの問題を修正するために何かを作成したり、react-docgenを改善したりするのは良いことです。

    通常の関数の注釈については、これは素晴らしいことであり、doczを使用して実行するのは本当に簡単で実行可能なことだと思います。 私は今週それについて考えています、そしてまでの

    JSファイルのメタ分析についてはよくわかりませんが、(TSファイルとJSファイルの両方で)typescript言語サーバーを使用して、同じAPIを使用してタイプやフィールドの説明などのメタ情報を収集することは実行可能だと思いますか? VSコードのようなIDE?

    アイデアは、ASTを変換する代わりに、成熟した高レベルAPIを使用することです。

    このページは役に立ちましたか?
    0 / 5 - 0 評価