jsdoc

0熱

1答えて

JSDocアノテーションを使用してタイプセーフティを適用することで、Javascript静的型付けの水に私の足をつけたいと思います（はい、私はFlow/Typescriptについて知っていますが、実際には大砲のようにつま先を浸しているわけではありません）ボールをプールに入れる）。私のJSDocアノテーションから自分のコードをタイプチェックできる唯一のツールは、Google Closureコンパイ

8熱

1答えて

JSDoc + Mongoose：どのようにMongooseモデルを文書化しますか？

私はMongooseスキーマ持ち、モデル：私はタブ補完を取得し、継承された両方の方法についてWebStormからの提案を入力しMyClientおよび/またはMyClientSchemaを（JSDocのを使用して）文書化する必要がありますどのように var MyClientSchema = new mongoose.Schema({ fist_name: { type: Str

1熱

1答えて

JSDocコメントブロックでタブが許可されていますか？

JSDocコメントブロックにタブを使用することは許可されていますか？代わりの /** * Some description * * @function * @name someName * @summary And a summary */ ... /** * Some description *

4熱

1答えて

jsdocをユートピアアプリケーションに使用する方法

流星アプリケーション内でJSDocを使用する正しい方法は何ですか？コードを文書化する方法はありますが、すべての部分に「接続」はありません。すべてがサンプルテンプレートに属しているため、jsdocの出力は正しく構成されている必要があります。この文書を改善するにはどうすればよいですか？私は仕事 Template.example.helpers({ /** * Get all

2熱

1答えて

このようなオブジェクトに対してJSDocを定義する方法は？例えば

私は@nameを経由して、オブジェクトの記述を有する： /** @name Point @prop {number} x @prop {number} y */ 、各プロパティがポイントであるオブジェクト、：それは /** * * @type {what?} */ var details = { something: {x:1.1, y: 2.2}, ano

0熱

1答えて

JS Docのenum値を文書化する方法

私はJSのドキュメントを生成するためにJS Docを使用しています。私はいくつかの値を持つenumを持っています。私は各プロパティのドキュメントを生成したい。私は以下を試した： /** * Enum for display state. * @readonly * @enum {string} */ var DisplayState = { /** @member {strin

8熱

3答えて

JS DocがPDFを生成できます

私はJS Docバージョン3（https://github.com/jsdoc3/jsdoc）を使用しています。このツールを実行すると、デフォルトでHTML形式のドキュメントが生成されます。 PDF形式の文書を生成することは可能ですか？

3熱

1答えて

JSDoc - 必須パラメータの構文を指定します。

私はJJDocを使用して、JavaScriptライブラリのドキュメントを作成しています。私はオプションのパラメータを示す方法を知っています。以下のように /* * @param {string} [somebody] - Somebody's name. */ function sayHello(somebody) { if (!somebody) { somebody

0熱

1答えて

tslintエラー：jsdoc内のAsterikを整列させる必要があります

このtslintエラーは引き続き発生しますが、コードに何が問題なのかはわかりません。誰もが正しく整列されていない以下のJSDocのをasteriksの問題を参照しています： /** * @ngdoc directive * @module ers.components.button * @scope * @transclude * @data * @binding * @name e

4熱

2答えて

フロータイプアノテーションを持つjsでjsdocを使用

jsソースをフロータイプアノテーションで処理しようとすると、jsdocパーサーは拡張構文を理解できません！フロータイプのアノテーションで拡張されたjsソースでjsdocを使用する方法がありますか、またはアノテーション付きのjs型からドキュメントを生成するための推奨される方法はありますか？