jsdoc 相关问题

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

我如何在Visual Studio Code中对事件使用JSDoc自定义EventEmitter?

我一直在研究Node.js项目,只是注意到Visual Studio Code提供了有关基本EventEmitter对象的信息。所以我想应该有可能为...

回答 1 投票 5

JSDoc用于复用功能接口

我正在连接到多个电子邮件工具,并将其API抽象为一个通用的sendEmail函数,每个服务具有相同的参数和相同的返回值。这意味着对于每个电子邮件服务(...

回答 1 投票 2

JSDoc的输出可以组织成“文件夹”吗?

我正在使用grunt jsdoc从JSDoc注释生成文档,使用默认模板。 在生成的文档中,模块文档的链接都显示在 模块 下的单个列表中。 这个项目使用Reac...

回答 0 投票 7

如何在compodoc中禁用模板选项卡?

我一直在寻找用于angular 2应用程序的doc生成器工具。我发现compodoc对我有用。在此工具的“组件”部分中,我不想生成源代码和模板文件。 -...

回答 1 投票 0

如何为`pipe`d ES6函数生成JSDoc

我有一个ES6样式的函数,该函数是使用asyncPipe的函数组合定义的。从'expo-secure-store'导入{getItemAsync}; const asyncPipe =(... fns)=> x => fns.reduce(异步(y,...

回答 1 投票 6

如何在JSDoc中记录结构化参数?

异步函数userInformation({userId,token}){const body = {user:userId}; const headers = {授权:`bearer $ {token}`,“ Content-Type”:“ application / x-www-form -...

回答 1 投票 0

JSDOC评论格式

我在静态属性获取器内部的聚合物类中具有一个属性,定义如下,并在属性上方对此进行了注释。 / ** *当textElement为空时,textElement( 标签)为...

回答 1 投票 0

如何为使用箭头函数的类方法的parms生成jsdoc?

我是一名学生,他的基本项目/工作综合学习即将结束。我正在制作技术文档,以移交给下一个将继续进行此工作的团队,但是...

回答 1 投票 0

使用JSDoc到文档模块导出类

CommonJS模块中的简单类具有以下JSDoc注释:/ ** *表示项目列表的类。 * * / module.exports =类List {/ ** *创建一个列表。 * / ...

回答 1 投票 0

可选地将useState类型与jsdoc,打字稿checkjs(javascript)

使用打字稿的jsdoc支持来键入以下javascript代码:const [optionalNumber,setOptionalNumber] = useState(null)const handleClick =()=> {setOptionalNumber(42)// ...

回答 1 投票 1

可选地将useState类型与jsdoc,打字稿checkjs(javascript)

使用打字稿的jsdoc支持键入以下内容:const [optionalNumber,setOptionalNumber] = useState(null)const handleClick =()=> {setOptionalNumber(42)// ^-参数...

回答 1 投票 0

@@对象的属性,tslint给出错误-无冗余jsdoc

我正在使用tslint作为我的打字稿代码。我要记录接口的属性。 tsLint给出错误JSDoc标签'@property'在TypeScript代码中是多余的。 (no-redundant-jsdoc)tslint(1)...

回答 1 投票 0

如何在构造函数内部声明的类属性中获得智能(在vscode中)

我正在使用vscode,并尝试创建具有智能感知能力的js代码。我无法创建类属性,因为它与Safari中的iPhone配合得很好(因为ES7、8、9等),因此,im ...

回答 1 投票 0

如何将JSDoc与通用打字稿一起使用?

将JSDoc用于一般打字稿功能的最佳方法是什么。下面是我尝试过的方法,但是我想有一种最佳方法,因为有信息说JSDoc类型可能会被移动...

回答 1 投票 0


如何记录在JSDoc字典?

有下一个例子:var CONF = {区域设置:{ “恩”:{名称: “英语”,郎咸平: “EN-US”}, “ES”:{名称: “西班牙”,郎咸平: “ES-ES”。 ..

回答 2 投票 44

如何使用jsdoc出厂的功能呢?

所以我有一个出口工厂功能的模块。工厂函数接受设置并返回绑定在该设置对象库。我不能为我的生活弄清楚如何记录?

回答 1 投票 1

与JSDoc记录工厂

为了避免用我的JavaScript代码新的,我写的工厂来创建对象。我已经尝试了许多组合,让我最满意的结果之一是:/ ** * ...

回答 2 投票 8

如何包括和排除目录与documentationjs解析

特别是,我感兴趣的是排除任何node_modules文件夹,但也有其他需要被排除在外。这通常是完成在配置文件;例如,一个.jsdoc文件,像这样:” ...

回答 1 投票 1

文档对象在JSDoc方法及其返回值

我有一个寻呼控制器工厂,返回一个寻呼控制器对象了一堆的方法(视图与互动,尤其是当最终用户确实喜欢浏览到一个动作...

回答 1 投票 1

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