tsdoc-param-tag-with-invalid- name：@param块后面应该跟一个有效的参数名称(TypeScript、ESLint和React)

tsdoc-param-tag-with-invalid-name：@param块后面应该跟一个有效的参数名称(TypeScript、ESLint和React)

在TypeScript、ESLint和React中，@param标签用于文档化函数的参数。它提供了对参数的描述和类型信息，以帮助开发人员更好地理解和使用函数。

然而，当使用@param标签时，必须确保在@param标签后面跟着一个有效的参数名称。这是因为参数名称是必需的，它用于标识参数并提供上下文。

如果在@param标签后面没有有效的参数名称，将会导致文档生成工具无法正确解析和显示参数信息。这可能会给其他开发人员带来困惑，并降低代码的可读性和可维护性。

为了避免这个问题，我们应该始终确保在@param标签后面提供有效的参数名称。这样可以确保生成的文档准确地反映了函数的参数信息，并提供给其他开发人员参考。

在TypeScript、ESLint和React中，可以使用以下方式来正确使用@param标签：

/**

函数描述
@param paramName 参数描述 */ function functionName(paramName: ParamType): ReturnType { // 函数实现 }

在上面的示例中，paramName是一个有效的参数名称，它用于描述函数的参数。ParamType是参数的类型，ReturnType是函数的返回类型。

推荐的腾讯云相关产品和产品介绍链接地址：

云函数（Serverless）：https://cloud.tencent.com/product/scf
云开发（CloudBase）：https://cloud.tencent.com/product/tcb
云数据库（TencentDB）：https://cloud.tencent.com/product/cdb
云存储（COS）：https://cloud.tencent.com/product/cos
人工智能（AI）：https://cloud.tencent.com/product/ai
物联网（IoT）：https://cloud.tencent.com/product/iotexplorer
移动开发（MPS）：https://cloud.tencent.com/product/mps
区块链（Blockchain）：https://cloud.tencent.com/product/baas
元宇宙（Metaverse）：https://cloud.tencent.com/product/metaverse

请注意，以上链接仅供参考，具体产品选择应根据实际需求和情况进行评估和决策。

页面内容是否对你有帮助？

有帮助

没帮助

相关·内容

[eslint配置和rule规则解释

eslint配置和rule规则解释 ESLint 是一个ECMAScript/JavaScript 语法规则和代码风格的检查工具，它的目标是保证代码的一致性和避免错误。...这种配置对配置文件所在目录及其子目录树中的所有文件有效。配置文件格式 JavaScript - use .eslintrc.js 文件导出一个包含配置信息的对象。...ESLint 兼容的语法分析器有：Esprima、Babel-ESLint、@typescript-eslint/parser，ESLint 默认使用 Esprima。...该参数的值为以下之一：一个指定基础配置来源的字符串一个指定基础配置来源的字符串的数组：数组中每个配置扩展它前面的配置 ESLint 支持递归扩展配置，所以基础配置中也可包含 extends 参数。...": 2,//函数参数不能重复 "no-duplicate-case": 2,//switch中的case标签不能重复 "no-else-return": 2,//如果if语句里面有return,后面不能跟

2.9K4 0

说真的，不如用ESLint插件替代掉部分技术文档

近期在尝试编写一个供予项目使用的eslint插件，目的是为了不写一行开发文档即实现项目规范强制落地。那么如何编写、启动和测试就比较头疼了，于是踩坑了一晚上之后，我决定把相关的开发流程分享出来。...: 如果需要让规则接受参数，开启该属性。其他的属性我们在开发的时候会讲到，这里主要补充一个messages参数，因为这是一个必要参数，但是示例中没有。 messages。...(name: string): boolean; //当前作用域中给定名称的变量标记为已使用。...这个函数有两个参数：一个是导入语句的数组，另一个是ESLint的上下文对象。该函数的主要流程如下：根据导入语句的路径，判断导入语句的种类。根据导入语句的方式，判断导入语句的方式。...没错就是.eslintrc.js 中常见的parser字段，目前我们需要关心的只有如何为我们的插件选择一个第三方解析器，比如“@typescript-eslint/parser”就是一个解析器。

1K1 0

Typescript真香秘笈

Typescript进阶篇 5.1 函数函数类型：函数类型主要声明的是参数和返回值的类型。...number, numberB: number) => number = function(a: number, b: number): number { return a + b; } 注意到类型定义时参数的名称不一定要与实际函数的名称一致...(animal.name); // 'tom' 注意在类的构造函数参数前加上修饰符是一个语法糖，上面的写法等价于： class Animal { public name: string;...Left, Right } export interface Options { data: any; } 对应的导入和使用模块应该是这样： // src/index.ts import...@typescript-eslint/eslint-plugin: 提供了typescript相关的eslint规则列表。

5.6K2 0

【JavaScript】ESlint & Prettier & Flow组合，得此三神助，混沌归太清

Flow Flow的意义 Flow是faceBook开源的一个JavaScript静态类型检查工具，作用类似TypeScript，但是它不像TS那样是一门独立的语言，而是作为一个babel-plugin...Flow真是眼前一亮，我就想，TypeScript挺好的，但或许也给人带来了一些烦恼，一旦用了TS，就意味着任何时候都要强制类型检查，我觉得，选择JavaScript还是TypeScript就变成了这样一个问题...（耐用指的是维护性），但Flow帮我们找到了折中方案：类型检查这东西，我们在想用和需要用的时候用，同时不想用也可以不用，就好比就是手里有1000块，那我们就刚好去买1000块钱的衣服 Flow的使用 /...你的环境？ 1.Node 2.浏览器 Q4. 你使用到的框架? 1.React 2.Vue 3. None of these Q5. 你的项目使用TypeScript?...如图所示 "rules":{ "no-console":1 } 每个项目后面可以跟0，1，2三种数字 0:不报错，不警告 1：警告但不报错 2:报错 5.extends 你可能会问了，哎呀！！

1.1K2 0

Node.js脚手架开发完全指南「TypeScript版」

---- 前言在koa入门系列中，我们介绍了koa2的最佳实践，并提供了一个koa2+TypeScript的最佳实践模版。...接收用户输入的项目名称、描述等，用于确定目录名称和修改package文件。接收用户的输入，定制项目内容（比如对中间件的选择）。查看help和version。对创建进度和创建结果，给出反馈。...npm install -save commander 我们先从简单的开始，接收一个输入作为新建工程的名称，先不做处理直接输出出来。 #!...又搞定一个，继续继续！！ handlebars-语义化模板继续完善，接下来我们要用输入的名称和描述、作者等文本，替换模板的对应字段。...总结本文实现了最简单的一个koa生成器组件，实现的理念是，脚手架和模板都尽可能的简单。实现过程的亮点，是使用了ts和大量ES7的语法糖，个人感觉代码风格算比较优秀的了哈哈。

1.9K1 0

前端反卷计划-组件库-01-环境搭建

环境搭建组件库名字因为我们的组件库要发布到npm上面，所以你的组件库名称不能和其他npm包的名称重复。...使用 React 推荐的规则 'plugin:@typescript-eslint/recommended', // 使用 TypeScript 推荐的规则 ], parser: '@typescript-eslint...', // React相关的ESLint插件 '@typescript-eslint', // TypeScript相关的ESLint插件 ], rules: { // 在这里添加你的自定义规则...react/react-in-jsx-scope': 'off', // 关闭React在JSX中的全局引入，适用于React 17+ 'react/display-name': 'off',...，在根目录创建.prettierrc.js，在这个文件进行配置module.exports = { // 箭头函数只有一个参数的时候可以忽略括号 arrowParens: 'avoid', //

2423 0

Vite + React + Typescript 构建实战

ESLint + Prettier 关于 ESLint 与 Prettier 的关系，可以移步这里：彻底搞懂 ESLint 和 Prettier 1、.eslintignore：配置 ESLint 忽略文件...install --save-dev eslint typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-react...Typescript 识别用的；这里建议采用的是 @/ 开头，为什么不用 @ 开头，这是为了避免跟业界某些 npm 包名冲突（例如 @vitejs） vite.config.ts // vite.config.ts...一个项目最重要的部分，就是路由配置；那么我们需要一个配置文件作为入口来配置所有的页面路由，这里以 react-router 为例：路由配置文件配置 src/routes/index.ts，这里我们引入的了...* @param storeName 指定子 store 名称 * @returns typeof StoreType[storeName] */function useStores<T extends

1.6K3 0

Sentry 开发者贡献指南 - 前端(ReactJS生态)

组件应该有一个关联的 .stories.js 文件来记录它应该如何使用。...例如：以前你会做类似的事情 let x = volume || 0.5; 这是一个问题，因为 0 是 volume 的有效值，但因为它的计算结果为 false -y，我们不会使表达式短路，并且 x 的值为...通过 webpack tree shaking 和 eslint 强制执行，我们应该能够保持合理的包大小。...虽然我们通常支持 hooks，但我们有一些关于 hooks 应该如何与 Sentry 前端一起使用的建议。使用库中的 hooks 如果一个库提供了 hooks，你应该使用它们。...注意 hooks 的规则和注意事项 React hooks 有一些规则。请注意 hooks 创建的规则和限制。我们使用 ESLint 规则来防止大多数 hook 规则被非法侵入。

6.9K3 0

深度讲解TS：这样学TS，迟早进大厂【21】：代码检查

上例中，我们使用了 var 来定义一个变量，但其实 ES6 中有更先进的语法 let 和 const，此时就可以通过 eslint 检查出来，提示我们应该使用 let 或 const 而不是 var。...npm install --save-dev @typescript-eslint/eslint-plugin 创建配置文件§ ESLint 需要一个配置文件来决定对哪些规则进行检查，配置文件的名称一般是...规则的取值一般是一个数组（上例中的 @typescript-eslint/consistent-type-definitions），其中第一项是 off、warn 或 error 中的一个，表示关闭、警告和报错...使用 AlloyTeam 的 ESLint 配置§ ESLint 原生的规则和 @typescript-eslint/eslint-plugin 的规则太多了，而且原生的规则有一些在 TypeScript...} 使用 AlloyTeam ESLint 规则中的 TypeScript React 版本§ AlloyTeam ESLint 规则中的 TypeScript React 版本 Troubleshootings

2.5K2 0

可能是目前最详细从零开始配置 TypeScript 项目的教程

这些构建工具在不同的场景下应该如何选型？ Babel 对于 TypeScript 的支持有哪些限制？列举你所知道的 ESLint 功能？如何确保构建和上传的代码无 ESLint 错误信息？...ESLint 和 Prettier 的区别是什么？两者在一起工作时会产生问题吗？ Linters 有哪两种类型的校验规则？如何有效的识别 ESLint 和 Prettier 可能产生冲突的格式规则？...当然如果是 React 组件库的 Demo 演示，则可以采用 dumi[129] 生成组件 Demo 演示文档（不知道没有更加好用的类 Vuepress 的 React 组件文档生成器，更多和 React...的名称 name: Algorithms # on: 指定 workflow 触发的 event # # event 有以下几种类型 # - webhook #...中显示的 job 名称 name: Build And Deploy # # needs: 用于继发执行 job，例如当前 job build 必须在 job1 和 job2

4.7K2 2

VSCode拓展推荐（前端开发）

2.2K4 1

TypeScript 真的值得吗？

在开始之前，希望大家知道，我是 TypeScript 爱好者。它是我在前端 React 项目和基于后端 Node 工作时的主要编程语言。但我确实有一些疑惑，所以想在本文中进行讨论。...——正确的同行评审可以检查出许多机器无法捕获的错误使用 linter，例如 eslint TypeScript 可以在这些基础之上增加额外的安全性，但我认为这在编程语言需求列表中应该排在后面。...通过这种方法，TypeScript 在健全和不健全的阵营中脚踏两只船。这种半途而废的现象是通过 any 类型强制执行的，我将在后面提到。我仍然需要编写很多的测试，这让我感到沮丧。...不健全以及 TypeScript 暴露在严格类型之外的各种转义符使它的有效性大大降低，不过这总比没有强一些。...我最近在一个 Angular 项目中工作，看到很多这样的代码： export class Person { public _id: any; public name: any; public icon

1.4K2 0

用TypeScript编写React的最佳实践

不要担心，本文我们来总结一下两者结合使用的最佳实践。 React 和 TypeScript 如何一起使用在开始之前，让我们回顾一下 React 和 TypeScript 是如何一起工作的。...我们一起来讨论下面的配置 tsconfig.json ESLint / Prettier VS Code 扩展和配置项目初始化初始化一个 React/TypeScript 应用程序的最快方法是 create-react-app...: 'detect', // 告诉 eslint-plugin-react 自动检测 React 的版本 }, }, }; VSCode 扩展和设置我们添加了 ESLint 和 Prettier...这是一个 React 和 TypeScript 协同工作的成果。在极少数情况下，你需要使用一个空值初始化 Hook ，可以使用泛型并传递联合以正确键入 Hook 。...它们位于一个名为 DefinitelyTyped 的存储库中，该存储库由 TypeScript 团队和社区共同维护。

4.7K5 1

【万字长文】深入理解 Typescript 高级用法

下面就引出了本小节真正的 "数组"：联合类型(Union Types) 说起联合类型(Union Types) ，相信使用过 Typescript 同学的一定对它又爱又恨：定义函数入参的时候，当同一个位置的参数允许传入多种参数类型...思考一下逻辑，发现其实并不复杂，用 Javascript 可以很容易地实现出来： /** * 合并多个参数的返回数值并返回 * @param { Function[] } reducerCreators...A : never; /** * 合并多个参数的返回数值并返回 * @param { Function[] } reducerCreators * @returns { Object } */...[ { "name": "typescript-eslint-language-service" /** 默认会读取 `.eslintrc.*` 文件 */.../** 具体配置参数请查看官方文档 */ } ] } } 插件基本介绍与使用场景此插件可以让 Typescript 原生支持 eslint 检查及告警，编辑器不需要安装任何插件即可自持

3.3K2 0

taro自学笔记：从零开始搞多小程序开发

，不同端的文件代码对外保持统一接口，而引用的时候仍然是 import 原文件名的文件，Taro 在编译时，会跟根据需要编译平台类型，将加载的文件变更为带有对应端类型文件名的文件，从而达到不同的端加载对应文件的目的...假如有一个 Test 组件存在微信小程序、百度小程序和 H5 三个不同版本，那么就可以像如下组织代码test.js 文件，这是 Test 组件默认的形式，编译到微信小程序、百度小程序和 H5 三端之外的端使用的版本...版本test.qq.js 文件，这是 Test 组件的 QQ 小程序版本test.quickapp.js 文件，这是 Test 组件的快应用版本四个文件，对外暴露的是统一的接口，它们接受一致的参数.../react#overrides[0]': Cannot find module '@typescript-eslint/eslint-plugin' Require stack:搜索了一下，网上都说，...安装这个两个包： "@typescript-eslint/eslint-plugin": "^5.0.0","@typescript-eslint/parser": "^5.0.0",实际并没有卵用解决问题是

6352 0

前端-团队效率（二）代码规范

"prettier.singleQuote": true, // #让函数(名)和后面的括号之间加个空格 "javascript.format.insertSpaceBeforeFunctionParenthesis...": "默认名称", "description": "默认描述", "param {type}": "默认参数", "return {type}": "默认类型", },...": true, // #每次保存的时候将代码按eslint格式进行修复 "eslint.autoFixOnSave": true, // 添加 vue 支持 "eslint.validate"..."prettier.singleQuote": true, // #让函数(名)和后面的括号之间加个空格 "javascript.format.insertSpaceBeforeFunctionParenthesis...": "默认名称", "description": "默认描述", "param {type}": "默认参数", "return {type}": "默认类型", }, // 将该选项设置为

1.3K3 0

Flow 与 Typescript：哪个更适合你的项目？

编译器接收 TypeScript 文件（.ts 或 .tsx），然后将它们“转换”为可由浏览器运行的有效 JavaScript 代码。...正如我们在上面的代码块中看到的，我们声明了一个函数，该函数接收一个具有两个属性的对象，分别是字符串和数字类型的名称和年龄。...在这里，我们声明了 Props 接口，它有一个属性 item，一个 Item 类型的对象数组——另一个接口有两个属性，一个 number 类型的 id 和一个 string 类型的 name，两者都是必需的...然后，我们通过添加注解 props：Props 说我们的函数组件 ItemsList 的 props 参数是一个 Props 类型的对象。...而如果你在开发一个大型项目，那么typescript应该是你最佳的选择，它庞大的社区让它的发展异常迅速，主流的框架源码都采用了typescript进行开发足以说明问题。

1.9K3 0

代码规范之-理解ESLint、Prettier、EditorConfig

关于TSLint(已停止维护) 使用过TypeScript的童鞋对于TSLint应该不会陌生，它是由TypeScript团队推出并维护的。...配置包扩展支持React语法；通过@typescript-eslint/parser解析器支持typeScript语法及校验等；三、ESLint 使用 Node.js 编写在前端项目中便于安装且有一个快速的运行环境...安装： yarn add --save-dev eslint 复制代码安装插件和解析器假如项目中使用了TypeScript和React，则安装： // 我们需要安装 @typescript-eslint...yarn add --save-dev typescript @typescript-eslint/parser // 安装eslint-plugin-react配置包扩展支持React语法；安装@typescript-eslint...每一个规则都应该是可被讨论，具体开启与否应该视团队而定；语言或框架某个写法如果是被严禁使用的，那它就应该在源头被消灭；之所以存在肯定有一定的意义的； ESLint不是神药，最佳代码实践往往在于多多探索

2.8K3 0

重构利器 jscodeshift

jscodeshift jscodeshift 是一个工具包，用于在多个 JavaScript 或 TypeScript 文件上运行 codemods，它是：一个运行器，它为传递给它的每个文件执行提供的转换...小试牛刀前面已经看过 codemod 和 recast 的示例，那本文的主角 jscodeshift 怎么用呢？本节就通过一个工作中会遇到的场景来深入感受工作机制。...@param {Object} api jscodeshift 所有的 api，这部分会在源码解析部分详细说明 * @param {Object} options CLI 传入的参数 * @returns...* @param {Object} options CLI 传入的参数 * @returns {string} 生成的代码 */ module.exports = (fileInfo, api,...下一篇会剖析 jscodeshift 的源码，让我们深入学习以下几点内容： jscodeshift 是如何实现链式调用的？怎么做到 JavaScript 和 TypeScript 的编译？

7912 0

一键格式化代码带来的快感 | 你还在为每个项目配置Stylelint和Eslint吗

Lint其实就是编辑器里运行的一个脚本进程，将代码解析成抽象语法树，遍历抽象语法树并通过预设规则做一些判断和修改，再将新的抽象语法树转换成正确代码。...若上传无任何校验痕迹的代码块，当其他组员将该代码块更新合并到原有代码上时，由于编辑器一直配置着团队编码规范，导致被拉下来的代码块立马报错甚至产生冲突。...eslint-plugin-react eslint-plugin-standard eslint-plugin-vue vue-eslint-parser # TypeScript Eslint...，搜索并安装Stylelint和Eslint，安装完成后重启VSCode 选择文件 → 首选项 → 设置，设置里可选用户和工作区「用户」：配置生效后会作用于全局项目(若大部分项目都是单一的React应用或...此时移步到VSCode右下角的工具栏，会看到禁用图标+ESLINT的标红按钮，单击它会弹出一个弹框，选择Allow Everywhere就能启用Eslint所有校验功能。

1.6K1 0

点击加载更多

扫码

添加站长进交流群

领取专属 10元无门槛券

手把手带您无忧上云