26得票2回答
JsDoc:如何记录一个对象可以具有任意(未知)属性,但具有特定类型的信息?

这与问题30360391类似。我想表达的是函数的参数是一个普通的JS对象,它可以具有任意属性(具有未知名称),但所有属性本身都是具有固定属性的对象。 例如:函数就像这样。 /** * @param {Descriptor} desc */ function foo( desc ) { ...

29得票1回答
JSDoc侧边栏中的嵌套方法

感谢在这里找到的答案: https://dev59.com/6WIk5IYBdhLWcg3we-L5#19336366 我的JavaScript文档组织得很好,格式也很好。每个命名空间都是包含方法的“父级”。但是,导航不够细致。 使用node.js工具通过简单的命令(jsdoc file...

11得票5回答
如何创建自己的jsdoc模板的详细文档是否存在?

简短版: 如果我想从头开始开发一个全新的 jsDoc 模板,我需要阅读哪些内容以理解 jsDoc 的功能、模板所必须提供的接口以及需要处理的数据? 详细版: 我已经使用了一段时间的 jsDoc,并遇到了一些我想要添加的标签和我想要生成的概述页面。到目前为止,我通过usejsdoc.org解决...

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

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

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

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

10得票3回答
使用@method还是@property来定义JSDoc对象方法?

JSDoc 3的文档包含以下示例: /** * The complete Triforce, or one or more components of the Triforce. * @typedef {Object} WishGranter~Triforce * @property ...

7得票3回答
使用Babel时静态类属性无法工作

我正在使用JSDOC以及所有支持npm插件来创建漂亮的文档。在运行jsdoc并解析JSX文件时,我遇到了困难,它总是在=符号附近抛出错误。 SyntaxError: unknown: Unexpected token export default class SaveDesign exten...

13得票3回答
JSDoc:在另一个@param中引用方法的参考

我是新手,正在学习使用JSDocs,但找不到答案。假设我想编写这个简单的函数:function hasQ(array, item) {return array.includes(item);} 使用 JSDoc,我会进行标记,如下:/** * Another way to call array...

24得票1回答
如何在JSDOC中记录对象数组

我有一个带有对象数组参数的函数,并希望使用 JSDOC 描述该参数(包括数组中对象的属性),就像这个示例一样:/** * @param {Array.<Object>} filter - array of filter objects * @param ... */ func...

74得票5回答
JSDoc中@param类型的枚举

在JSDoc的@param类型声明中是否可以像下面的例子一样使用enum?/** * @enum { Number } */ const TYPES = { TYPE_A: 1, TYPE_B: 2 } /** * @param { TYPES } type */ f...