jsdoc

1熱

1答えて

SublimeまたはVS Codeでは、Intellisenseが認識する特別なコメント（例：DocBlockrまたはJSDocs）を定義して、スマートなツールチップ機能を与えることができます。私はoptionsパラメータをとる関数を持っています。これはオブジェクトであり、いくつかの機能が含まれている可能性がプロパティ、文字列、int型などの例を持つことができるようになります： function

0熱

1答えて

jQueryパラメータを使用したPhpStormの警告

私はPhpStormを使用しており、JSDocを使用してパラメータをjQuery型として定義すると警告が表示されます。 jQueryをライブラリとして設定しようとしましたが、動作していないようです。これは私のコードです： /** * @param {jQuery} $button */ function setActive($button) { // The code is w

2熱

1答えて

ドキュメントJavaScriptのオプションの最初のパラメータ

JavaScriptの最初のパラメータは、オプションのを持つ迷惑な関数の1つを文書化しようとしています。機能のようなもの.use() expressから function use(path, callback) // path is optional 私は働く何かを見つけようとし、理想的にはひどく醜いではありませんよ。実際のコード署名用私の好みはこの次のようになります。その場合 funct

0熱

1答えて

引数オブジェクトの関数定義を文書化する方法

クラスの引数は、その引数が関数（whoah）であるプロパティを含むプロパティである場合にどのように文書化できますか。例： class MyClass { /** * @param {Object} options - configuration for the class * @param {Function} options.onSuccess - a callb

2熱

1答えて

わかりやすいES6コードのドキュメント例

ES6ドキュメント用のいくつかの種類のチートシートのように、ドキュメントのES6コードへの適切なドキュメントサンプル/参照を見つけるのには苦労しています。新しいES6 + /リアクト構文またはより複雑なのparamsに合うドキュメント私は、JSDocのドキュメントに合わせたいのですが、この質問への最も一般的な答えの中で、私は唯一の些細なコードのドキュメントを見つけるために管理することができ、そし

0熱

1答えて

JSDoc @param - 別のモジュールからの参照クラス

私は2つのノードモジュールを持っています。モジュールAで、私は次のような定義があります /** * HTTP Client * @module src/http/client */ /** * A HTTP Client * @alias src/http/client */ class HTTPClient { [... class def with documente

0熱

1答えて

vscodeでjsdocを色分けする方法は？

jsファイルを開くとき、@paramだけが色を持っています。 {オブジェクト}のような他の構文にどのように色を追加しますか？

0熱

1答えて

基本パスは同じだが要求構造は異なる2 apisのスガーガースペックを定義するにはどうすればよいですか？

例：これは最初の定義である： /** * @swagger * /a/b/items: * get: * description: Get all the items * responses: * 200: * Returns an array of items */ これが第二の定義です： /** * @swagger * /a/b/items: * get

3熱

1答えて

TypeScriptコンパイラのJavascriptでJSDocをどのように記述しますか？

私はTSコンパイラでJSコードをチェックする能力があることを知っています。そして私はTSコンパイラがJSDocコメント（https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript）を理解していることを知っています。私は私のプロジェクトを反応させ、私はJSDocのと小道具の定義を指定する方法がわからないとTSコン