ReactJSでのドキュメントの作成方法

Question

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

Answer 1

最後に私が最初にこのリンクにアクセスして、適切に文書を読み、解決策を見つけた： - Read Document ここで、次の手順を実行します -

あなたのコマンドを開き、プロンプト

コマンドでグローバルJSDocのをインストールします。をNPMは、インストールJSDocの-g

今すぐあなたのプロジェクトフォルダのパスに移動して、コマンドを実行します。JSDocののSRC -r -dドキュメント上記のコマンド

は、プロジェクトディレクトリのドキュメントフォルダにドキュメントを作成します。

Answer 2

このパッケージをお試しください。このパッケージには、理解しやすい例があります。

React.createClass、ES2015クラス定義または関数（ステートレスコンポーネント）を介して定義されたReactコンポーネントのデフォルト実装を提供します。これらのコンポーネント定義は、分析可能にするために特定のガイドラインに従わなければなりません（詳細は下記参照）。

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

Answer 3

我々は、我々はReact Styleguidistを使用してコンポーネントライブラリを反応させるの文書化。

それは、次の機能を使用してコードを解析します：

• をユーザーが定義したPropTypesからAPI /小道具のドキュメントを生成します。
• 人が簡単にスニペットをコピーできるようにするライブ編集可能なサンプルのドキュメントを作成します。
• かなりうまく構成可能で、内部のドキュメントを実現するためにホットリロードしています。

これは、Webpackを通じてWebアプリケーションを構築することによって動作します.Webpackは、ローカルで使用することも、すべての開発者のためにホストすることもできます。

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

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

Answer 4

私たちは、コンポーネントLIBSに反応し、それは値下げでドキュメントを書いて、サンドボックスを持つことができますreact-showroom

を使用するのがたくさんあります。 これは大きな利点です。すでに設定されているウェブパック、ベベル、糸くずなどで2分以内に新しいプロジェクトを開始できます。

非常にお試しください。

Answer 5

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

チェックアウトプロジェクトここ意思興味https://github.com/LaustAxelsen/wilster-doc