jsdoc 相关问题

JSDoc是一种用于向JavaScript源代码添加内联API文档的语法。这与解析和操作遵循JSDoc语法的代码的各种工具不同。

有没有办法在JSdoc中指定通配符导出?

在我的项目中,数据库模型是从models文件夹动态加载和导出的。我想要做的是在JSdoc中指定任何module.exports属性是一种Sequelize ....

回答 1 投票 0

jsdoc:来自其他模块的引用typedef-ed类型

假设我在js模块中有一个typedef类型// somewhere / foo.js / ** * @module * / / ** * @typedef Foo * @type {object} * property {string} bar - some property * / Is有可能参考......

回答 2 投票 6

在Node.js中使用res.json的PhpStorm未使用的属性警告

我在AssessmentController.js中有这两个函数:/ ** *获取所有评估* * @param req * @param res * @returns {Promise } * / static async GetAll(req,res){try {...

回答 2 投票 1

如何在JSDoc中重复相同的文本,比如C语言中的#define

当我定义链接时,我必须多次重复相同的文本。例如:一个链接是{@link Parameter / peso / tiesto / casero~parametro.html#.isReal} {@link Parameter / peso / tiesto / casero~parametro.html#...

回答 1 投票 0

在带有流类型注释的js上使用jsdoc

当尝试使用流类型注释处理js源时,jsdoc解析器很难理解增强的语法!有没有办法在使用流类型增强的js源中使用jsdoc ...

回答 2 投票 5

使用jsdoc记录javascript构造函数的返回

我有一个返回构造函数的javascript函数(参见下面的代码示例)。我如何使用jsdoc的@returns标记来记录这一点。做@returns {MyConstructor}似乎不正确......

回答 3 投票 3

如何在jsdoc中定义一个带有spreaded参数的回调?

我试图在jsdoc中定义一个带有可变数量参数的回调,但是我的linter告诉我至少有一个参数是预期的,但是给出了0。 / ** *这是听力等于...

回答 1 投票 0

类型'string'不能赋值为'“get”| “后””

如何使用jsdoc将值从字符串转换为字符串文字类型?当我这样做时:export default class extends Vue {Request(... args){/ ** @type {'get'|'post'} * / let method ...

回答 1 投票 0

JSDoc for对象中的Lambda函数

我需要使用JSDoc来生成sock,数据变量已知var exec = {/ ** * @param {Number} sock * @param {String} data * / 1 :( sock,data)=> {console.log(“ GG“); } ...

回答 1 投票 0

仅在具有类型中定义的确切属性的常量中声明对象

我们在基于JS的应用程序中使用typescript和JSDoc,仅用于定义我们在函数中使用的参数类型。在特定情况下,我们希望对象具有已定义的...

回答 1 投票 1

如何在不破坏格式的情况下编写包含JSDoc中的javascript注释的模板文字?

我想用一些@example使用JSDoc来记录javascript函数,但它破坏了JSDoc。我想要的代码示例看起来像这样(我想要的版本):stripJSDoc(`/ ** * Hello * / ...

回答 1 投票 1

如何设置JSDoc教程标题?

我正在使用JSDoc教程,如http://usejsdoc.org/about-tutorials.html中所述我无法使配置选项工作,我还没有找到任何关于该主题的示例或讨论。 。

回答 1 投票 1

如何在NetBeans中的JSDoc注释中转义@符号

我在API中有一个简单的方法,允许使用JSONPath搜索对象。由于它的语法对于初级开发人员来说几乎是不熟悉的,所以我决定在JSDoc注释中提供一些示例。然而,......

回答 2 投票 10

JSDoc typedef 在单独的文件中

我可以在单独的文件(例如 types.jsdoc)中定义所有自定义类型,以便它们可以在整个应用程序中重用吗?正确的做法是什么? /** * 二维坐标。 * @typedef {对象}

回答 6 投票 0

如何让VS Code了解JSDOC跨多个文件的@typedef

我想在一个文件中指定一个类型,并能够在另一个文件中重用它。我尝试过模块,但它在VS Code中不起作用。还有其他解决方案吗?只想让我的项目的所有类型都...

回答 2 投票 12

如何更改JSDoc Tutorial标题

jsdoc真的很轻,没有解释。您能否告诉我如何更改“教程”部分的名称,并根据此文件包含多个部分? tutorials / file1.md教程/ ...

回答 1 投票 0

通过jsdoc在typescript类中定义新方法

我正在尝试在打字稿中使用“mixins”设计模式。问题是webpack不会转换源代码,因为我使用的是mixins中声明的方法,而不是主类中的方法。 ...

回答 1 投票 1

扩展对象的文档

我正在编写一些赛普拉斯和javascript进行一些测试,我有一个Object cy。这个对象是有记录的,我得到了一些intellisense,但是我想用我自己的一些来扩展它...

回答 1 投票 1

VS代码中的Vue数组支持JSDoc TypeScript错误:类型'ArrayConstructor'缺少类型'MyCustomType []'的以下属性

受“使用JSDoc进行类型检查”部分的启发“为什么我不再使用带有React的TypeScript以及为什么你也可能想要切换”,我使用的是Vue CLI创建的项目与ES6但没有TypeScript ...

回答 1 投票 0

如何使用有限的可能值记录jsdoc中的字符串类型

我有一个接受一个字符串参数的函数。此参数只能包含一些已定义的可能值。记录相同内容的最佳方法是什么?应将shapeType定义为......

回答 5 投票 60

© www.soinside.com 2019 - 2024. All rights reserved.