13得票4回答
TypeScript会剥离注释并破坏JSDoc文档。

目标是从TypeScript代码获取JSDoc文档。TypeDoc(TypeScript文档解决方案)的文档质量不可接受,因为该文档针对的是JS用户,不应淹没特定于TypeScript实现的细节(接口等)。当前,将TypeScript编译成ES6并从JS文件生成文档基本可以解决问题。但未分配值...

12得票4回答
React Hooks - 使用解构数组变量的JSDoc

我正在尝试使用hooks为一个简单的React Typescript组件进行JSDoc注释。不幸的是,我似乎找不到一种让JSDoc与已声明的解构数组配合使用的方法。有关解构对象参数的一些答案,但这些不适用于数组。/** * @property {boolean} 0 - documentat...

22得票4回答
JSDoc:多行描述@property

我正在使用jsdoc记录我的代码,目前一切都很好,我有一个像下面这样的注释... * @property {string} mode - mode of display 'video' - display video or 'audio' - play only the audio. * ...

12得票3回答
能否使用JS Doc生成PDF文件?

我正在使用JS Doc 3版本(https://github.com/jsdoc3/jsdoc)。运行该工具时,默认情况下会生成HTML格式的文档。是否可以生成PDF格式的文档?

9得票1回答
如何为具有不同类型键的对象编写JSDoc?

JSDoc API说,您可以像这样文档化对象: 请点击此处 。 {Object.<string, number>} 并记录多种类型: {(number|boolean)} 但是,如果我尝试指定一个既可以使用字符串也可以使用数字作为键的对象,则无法使用。VSCode/JS...

13得票2回答
如何从JSON模式创建JSDoc类型

我有很多适用于Node.js项目的JSON模式。我能以任何方式使用它们来: 从“.js”代码文件中访问它们作为jsdoc类型,以提高webstorm智能感知的准确性 或者自动创建jsdoc类型定义 吗?

15得票3回答
JavaScript + JsDoc:如何记录新的ES6数据类型,如map?

我正在尝试在我的ES6项目中使用JSDoc,我正在返回一个Map:/** * Some documentation.. * * @returns {undefined} <- This should be replaced */ function returningMap() ...

9得票1回答
使用Node生成的JSDoc生成的index.html文件为空。

我使用以下命令从JavaScript文件生成HTML。 $> jsdoc --debug jquery.js $> open out/index.html 该命令的输出结果 DEBUG: JSDoc 3.3.2 (Sat, 13 Jun 2015 22:20:28 GMT...

12得票2回答
在JSDoc中描述对象数组

我有一个函数,它接受一个对象数组。 看起来像这样。myAwesomeFunction([ { name: 'someName', next: false, test: 'test' }, { name: '...

11得票1回答
使用JSDoc创建自定义标签

我正在尝试在jsdoc 3.4.2中创建自定义标签。 config.json 文件是 { "tags": { "allowUnknownTags": true, "dictionaries": ["jsdoc","closure"] }, ...