jsdoc

1熱

2答えて

ExternalsセクションをjsDoc出力から正しく除外できますか？私のプロジェクトでは、ナビゲーションパネルには表示したくない外見がたくさんあります。すべてのスペースを占有していて、私たちにとっては役に立たないものです。ファイルnode_modules\jsdoc\lib\util\templateHelper.jsのコードを変更することで手動でハックすることができましたが、これは私の開発

1熱

1答えて

JSDoc：プロパティ名

jsdocに "+"のような特殊記号を含むプロパティの正しい説明を作成する方法はありますか？例： /** * @typedef {Object} TestObject * @property {string} "id+name" */ "ID +名前は" この場合、無効な構文のようです。

1熱

1答えて

JSDocの：HTMLページにJSDocのによって生成されるように、参照のtypedef-EDタイプの他のモジュールから

私はJSモジュールに // somewhere/foo.js /** * @module */ /** * @typedef Foo * @type {object} * property {string} bar - some property */ をtypedefのタイプを持っていると仮定するとは、別のモジュールでは、このタイプを参照することが可能です型は型定義されたモジ

0熱

1答えて

ファイル/モジュール別にjsDocを分離する方法

ドキュメントを生成すると、すべてのドキュメントが1つのファイルに格納されます。 jsDocを複数回呼び出す以外に、ファイルごとに名前を変更すると、タグやフラグを使用してドキュメントを分離する方法はありますか？

1熱

1答えて

VSCodeは、私はこのように私の機能をjsdoc'edしたオブジェクト

で適切なのparamsを示していない。：paramsキーが正常に機能のホバー上に展開されていないが /** * @typedef {Object} SearchTerms * @property {string} what * @property {string} where * @property {boolean} online */ /** * From react-rou

0熱

2答えて

オンラインで生成されたJSDoc

jsdocsオンラインまたはスタンドアロンツールでhtmlを生成する方法はありますか？内部のJSライブラリを作成し、それをJSDoc仕様で文書化して、私のチームと共有するドキュメントを生成したいと考えています。私は自宅のようにjsdoc npmパッケージをインストールすることはできません。 JSDocをインストールせずにhtmlドキュメント（または同様のドキュメント）を生成する方法はありますか？

1熱

1答えて

JSDoc別の@typedefオブジェクトのすべてのプロパティを含める

JSDocを使用して2つのオブジェクトを作成すると、そのうちの1つは他のすべてのプロパティを持ちます。あなたが持っていると思います。例えば： /** * @typdef Foo * @type {Object} * @property {string} bar * @property {string} baz */ /** * @typedef Foobar * @type {

3熱

1答えて

Visual Studioコード：属性のJSdocを表示

x:10,の上にカーソルを移動すると、Point.prototype.xのJSdocが表示されます。目標は私がpt.xの上にマウスを置いたときと同じJSdocを持つことです。現在のバージョンのVisual Studioコードでは不可能な場合は、自分の拡張機能を作成することで可能でしょうか？その場合、vscode名前空間APIのどの部分がこれに関連していますか？ class Point {

1熱

1答えて

流星-JSDocのは、内部または外部コマンドとして認識されない、操作可能なプログラムまたはバッチファイル

私はここの手順に従って、既存の流星プロジェクトに流星-JSDocのを設定しようとしています： https://www.npmjs.com/package/meteor-jsdoc 私が使用していますwindowsとn> install -g meteor-jsdocを実行すると、正常に実行されます。しかし、meteor-jsdocを実行しようとすると、タイトルと同じエラーが発生します。フォルダ

0熱

1答えて

IDEがJSDocを使ってメソッドを認識しない

私は以下のように定義された関数を持っています。 /** * @type Object * @return {typeof hello} hello */ function hello() { /** * Prints some words * @param {string} words - words to print * @returns {s