jsdoc

17熱

1答えて

JSDocのsocket.on文書化するための適切な方法（「イベント」、機能を（）{}）とルートハンドラ

形式（単一ファイル）を以下のいるJSDocの // api.js exports.addSocketEvents = function(socket) { /** * This will do that and ... * @param {Object} data Some data * @param {string} data.bla Somethin

7熱

2答えて

は、このコードを考える

を約束しますError？ /** * @return << Here, what do I have to write? >> */ function asyncFoo() { ... }

8熱

3答えて

node.jsで実行されているスクリプトでjsdocを使用するには？

jsdocモジュールを使用して、一部のソースコードからドキュメントエントリを抽出したいと考えています。 jsdocモジュールをインストールしました。コマンドラインにjsdocを使用できます。しかし、私のコードでrequire("jsdoc")とすると、nodejsはCannot find module 'jsdoc'というエラーを投げます。私はnodejs v0.8.25とJSDoc 3.3.

2熱

1答えて

JSDocの - このような複数のオブジェクトクラスを受け入れる配列を文書化する方法、JSDocの中で混合配列

の文書： Fooと Barのに受け入れられる唯一のクラスであるようなタイプを作成する方法 var arr = [new Foo(), new Bar()]; アレイ？

1熱

1答えて

object.definePropertyで定義されたmodule.exportsを文書化する方法

私はNodeJSを使用しており、JSDocをプロパティに取得しようとしています。 Object.defineProperty(module, 'exports', { enumerable: true, configurable: true, get: function() { const factory = {}; /** *

7熱

1答えて

JSDocで工場を文書化する

JavaScriptコードでnewを使用しないように、私は工場を作成してオブジェクトを作成します。私は多くの組み合わせを試してみましたし、私の最も満足のいく結果を与えてくれるものは以下の通りです： /** * Document module * @module app/document */ (function() { 'use strict'; /**

6熱

1答えて

jsdocとgulpの使い方は？

jsdocを使用してドキュメントを構築するgulpコマンドを作成するにはどうすればよいですか？ gulp-jsdocパッケージは使用したくないですが、維持されていません。そして私がコマンドラインから呼び出すために使用していたパッケージgulp-shellはgulp blacklistにあります。

7熱

1答えて

JSDocからSwagger YAMLを生成していますか？

私は、JSDocで完全に文書化された大きなJS APIを持っており、ネットワーク上でAPIを利用できるようにするために、魅力的なRESTサービスを構築しています。私は手動でYAML swagger仕様の初期バージョンを作成しましたが、問題は進化しているため、特に関連するオブジェクトのプロパティでJS APIと急速に同期しなくなるという問題があります。私がしたいのは、JSDocのコメントから少な

5熱

2答えて

Visual Studioのインテリセンスは

活字体インテリセンスが、このために正常に動作脂肪の矢印の機能と連携されていません。 class SampleClass { /** * Does stuff * * @param blah stuff needing done */ public doStuff(blah: string) { } } var sample

7熱

1答えて

JSDoc出力内のコメントの順序を維持する

私はJavaScriptオブジェクトを持っています。パブリックメソッドがいくつか紹介されています。JSDocを使用してそれらをドキュメント化したいと思います。私は、これらの機能をグループ化して順番に並べ替えていますが、JSDocを生成した後、すべてをアルファベット順に受け取ります。それはあまり意味がありません。出力に順序を保持する方法はありますか？私は答えを見つけることができませんでしたが、私