jsdoc

1熱

1答えて

緩い拡張を使用するモジュールにjsdocドキュメントを追加する適切な方法は何ですか？あるいは、実装を間違って設定するだけですか？最終的に私の共有メンバーが最終的な文書に含まれることを期待しています。ルース拡張モデル（as described here）を使用して作成したモジュールでJSdocを使用しようとしています。モジュールはのラインに沿っている：私はこのコードでJSDocのを実行すると /*

2熱

1答えて

JSDocからのIntellisenseがVSCodeでインポートされた型に対して機能しない

ES2015クラスをJSDocの型として使用すると、require文を介してそのクラスをインポートするファイルで正しく動作しないように見えます。クラスが定義された同じファイル内で作業している間は、すべてが期待通りに機能します（下記参照）。異なるファイル内のクラスを働いている間、正しくインポートし、（下に示す）そのコンストラクタタイピングを表示するように表示されます。しかし、私は（最初の画像で

7熱

2答えて

Visual StudioコードでJSCodeで生成されたドキュメントを表示するにはどうすればよいですか？

私は、Visual Studio CodeでAngular 2/Typescriptプロジェクトを構築してきており、丁寧にJSDocコメントブロックを追加していますが、今はJSDoc出力を見たいと思います。私は自分のJSDoc生成システムをインストールしてセットアップすることができましたが、VSCのすてきなGUIサポートがあれば、VSCからJSDoc権限を生成して表示することは合理的です。私のG

18熱

5答えて

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

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

0熱

1答えて

JSDoc：オプションの戻り値を正しく指定する方法

私の仕事は、正しいJSDocで関数をドキュメント化することです。関数がを返した場合、がトリガされます。そうでない場合、トリガされません。しかし、いずれの場合でも、戻り値はブール型でなければなりません。私の変異体である：私は喜ば * @return {boolean=false} trigger for default event handler: * * Value | Descriptio

1熱

1答えて

エラー： ""を解析できません：予期しないトークン（JSDoc）

JsDocのドキュメントに従ってクラス、プロパティ、メソッドを定義しましたが、 "/ somePath"を解析できません：予期しないトークン。私のクラス定義は次のようになります： - /** * class representing Lab testResults * @param {object} props: contain all the property */ class LabT

0熱

2答えて

JSDocs - どのように暗黙のパラメータを文書化するために、私は次のような機能を文書化する方法を疑問に思って

を返します。 var createInput = function() { var type = this.type; this.input = { val: {}, type: type }; } 技術のthis.typeは、入力パラメータとthis.inputであることは、このオブジェクトから返されるものです。これをどのように文書化しま

1熱

1答えて

私の.cssおよび.scssファイルにJsDocを使用できますか？

私は.csと.scssファイルのドキュメントが必要な反応アプリケーションに取り組んでいます。私のコンポーネントのソースコードについては、JsDocを使用してドキュメントを生成しています。しかし、私は.cssと.scssファイルにも同じものを使いたいと思っています。出来ますか？それ以外の場合は、.cssファイルと.scssファイル用の文書を作成する最適なソリューションは何ですか？

0熱

1答えて

JSDocは同じ変数を2回出力します

JSDocはすべてのメンバーのリストを2度印刷します。また、これらのリストでは、すべてのメンバーを2回も印刷します。どのような考えがこの現象を引き起こす可能性がありますか？これは私のコードです： /** @module styles */ /** * Contains the general styles * @var _ */ var _ = StyleSheet.create(

1熱

1答えて

オブジェクトのプロパティにJSDocを使用して関数のパラメータを記述する

オブジェクト（またはより正確にはノードにmodule.exportsに割り当てられたオブジェクト）があり、このオブジェクトのプロパティが関数で構成されている場合、どのようにパラメータを記述し、関数？例： module.exports = { /** * Adds two numbers together. * @param {number} first The fi