jsdoc

0熱

1答えて

私はJavascriptプロジェクトで作業しています。デフォルトの書き出し（モジュールが必要なときに得られるもの）は、クラスを拡張するクラスのインスタンスです。例えば： /** * @module my-module-name */ /** * Private so documentation doesn't mention DefaultRouter * @private */

1熱

1答えて

VSCode JSDoc Intellisense用のマルチライン

ドキュメントにJSONの例がありますが、これはVScodeのインテリセンスにJSONの例があります。私はこの本の中で私が考えることができるすべてのトリックを試しました。これは改行やJSONを読みやすくするためにできることでしょうか？私は何をしても、これをVScodeで動作させることはできません。それは空白を取り、1行になります。私がやろう：もちろんの /** * { * "JSONData

7熱

3答えて

JSDoc生成ドキュメントのグループ化関数

私は作業中のlibのドキュメントの生成を処理するためにdocumentationjs（jsdocを使用しています）を使用しています。私のlibはES6で書かれており、完全に機能しており、現時点では生成されたドキュメントはlibのすべてのモジュールのすべての機能のアルファベット順のリストです。これはあなたが探しているものを見つけることを非常に困難にします。 1つのファイルの関数がドキュメントにまとめ

0熱

1答えて

Visual StudioコードのIntellisenseで関数のドキュメントをどのように表示しますか？

私はMac上でVisual StudioコードでJavascriptを書いています。私はJSDocの形式で文書化され、この機能を、持っている：しかし /** * Adds the passed Matter Body to the simulation. * @param {Matter.Body} body - The body to add to the physics simulati

12熱

2答えて

VSCode：複雑なオブジェクトで解決する約束を文書化するには？

私はPromiseを返す関数fを持っています。 Promiseresolve({name: String, data: Object})またはreject(Error)のいずれかが返されました。 VSCodeに（an issue in JSDocで述べたように）私は、次の構文を試してみたが、それは動作しません： /** * @promise fPromise * @reject {Error}

1熱

1答えて

マニュアルJSDocコメント - テンプレートの作成

開発者がES6コードを文書化するためのJSDocテンプレートを作成するように求められました。私は70 or so @ block tagsのどれが役に立つのか、私は余分なドキュメンテーションの必要性を持って開発者を悩ませているのかどうかはわかりません。 documentationは非常に簡単な例を示していますが、実際には役に立ちません。経験豊富なJavaScript開発者にとって最も有用なブロッ

2熱

1答えて

JSDocで独自のタイプのクラスを正しく定義する方法は？

私はシンプルなES6クラスを持っています。私はJSDocでそれを正しく記述する方法を知っています。 WebStormのオートコンプリートによって後で認識される、独自のタイプを定義したいことに注意してください。以下の例は有効ですか？ /** * @typedef {Object} View * @class */ class View{...}

-1熱

1答えて

JavaScript Angularプロジェクトで動作するJSDoc

私はAngular CLIから構築したAngular 4プロジェクトに取り組んでいます。次は私がこの指示に従ってたJSDOC インストールしたい：だから、 - npm install -g jsdoc - npm install --save-dev jsdoc は、今私はそれがインストールされています。私の質問は...次にdocファイルを生成するにはどうすればいいですか？それは、この

1熱

2答えて

jsdocとvscode：別の関数の引数として渡された関数のドキュメント化

javascriptの関数への入力パラメータを文書化しようとしていますが、jsdocでそれを行う方法を考えることができません。私は、@callbackコメントを使用する必要があることを示唆しているjsdocのドキュメントを見てきましたが、Visual Studio Code（vscode）はスクリーンショットのとおり強調表示していません。 location パラメータのインテリセンスは、タイプl

0熱

1答えて

TernはJSDocタイプ情報を使用できません

Ternを使用して、一部のJavascriptコードでタイプ推論を実行しようとしています。しかし、型推論はコードの横にJSDocコメントを使用しているようには見えません。問題の例としてコード/** @type {Foo} */ let x;を使用しています。 Tern website's demo page（CodeMirrorを使用）では、エディタはxのタイプがFooであると推測することができ