web-dev-qa-db-ja.com

ReactJSでドキュメントを作成する方法は？

私は、reactjsアプリケーションで定義する各コンポーネントのdocファイルを作成する必要があります。任意の拡張子のドキュメントを作成するために使用できるnpmを探しています。コンポーネントを追加し、それを任意の拡張子のドキュメントに変更します。どうすればサポートできますか？私の質問はjsdocに関して見つかった他の質問とは異なります。jsdocを使用してreactjsのドキュメントを探しているからです。

javascriptreactjsjsdoc
26
jack

最後に、私は解決策を見つけました、最初にこのリンクに行き、文書を適切に読んでください：- 文書を読む 今、次のステップを実行してください：-

  • コマンドプロンプトを開きます
  • コマンドでJSDocをグローバルにインストールします：npm install jsdoc -g
  • 次に、プロジェクトフォルダーのパスに移動して、コマンドを実行します：jsdoc src -r -d docs
    • 15
    jack

    React Styleguidist を使用して、Reactコンポーネントライブラリを文書化します。

    次の機能を使用してコードを解析します。

    • 定義したPropTypesからAPI/propsドキュメントを生成します。
    • 簡単にスニペットをコピーして貼り付けることができるライブの編集可能なサンプルドキュメントを作成します。
    • それはかなりよく設定可能であり、内部ドキュメントを達成するためのホットリロードがあります。

    これは、Webpackを介してWebアプリを構築することで機能し、すべての開発者がローカルで使用することも、どこかでホストすることもできます。

    私たちにとっては、かなりうまく機能し、時間の経過とともに改善されます。

    編集：フードの下で react-docgen を使用します。

    10
    Kev

    このパッケージには、理解できる例が含まれています。

    React React.createClass、ES2015クラス定義または関数を介して定義されたコンポーネント（ステートレスコンポーネント）のデフォルトの実装を提供します。これらのコンポーネント定義は、分析可能な特定のガイドラインに従う必要があります（詳細については以下を参照してください情報）。

    https://www.npmjs.com/package/@rtsao/react-docgen

    4
    Sagar Shetty

    JSDocには better-docs というテーマがあり、@ componentプラグインがあります。コンポーネントに（他のタグとして）追加すると、propTypeがすべて解析され、ドキュメントが生成されます。さらに、@ exampleタグと組み合わせて使用​​すると、better-docsはライブプレビューを印刷します。

    0
    wojtekk

    多くの反応コンポーネントライブラリがあり、 react-showroom を使用します

    enter image description here

    マークダウンでドキュメントを作成し、サンドボックスを使用できます。これの大きな利点-構成済みのwebpack、babel、lintなどを使用して、2分で新しいプロジェクトを開始できます。

    試すことをお勧めします。

    0
    visortelle

    React-docgenの小さなラッパーを書いたので、それが少し簡単になりました。渡されたフォルダー内のすべてのコンポーネントのマークダウンファイルをエクスポートします。

    プロジェクトをチェックアウト https://github.com/LaustAxelsen/wilster-doc

    0
    Laust Axelsen